Overview

  • Getting Started

  • Going Deeper

  • Working with the Athens Repo

  • Github & Github Style Guide

    • Commits

    • Issues

    • Pull Requests

Revise:

The final Athens vision is for everyone, one day, to learn how to learn anything.

To do that, it is mission-critical to create a space and culture where we can work with one another and learn from one another.

We're always looking to bring new people and new ideas into Athens. There's plenty of ways to get involved, from development, design, documentation, and more. Don't hesitate to jump in!

Getting Started

  • Review the Code of Conduct

  • Complete the Contributors License Agreement

  • Check out ways to Get Involved

  • Join our mailing list

  • Participate in conversations on our Discord server

  • Follow updates on new Athens versions

Going Deeper

  • Use Athens and share your experiences

  • Participate in

  • Report when something is broken

  • Request new features to add functionality

  • Share your expertise

  • Improve Documentation

Working with the Athens Repo

  • Set up your deployment environment

  • Check out editors and other tools that will support your contributions

  • Follow the roadmap, releases, and current projects

  • Learn about the Athen's testing process

Developers

  • Join our Discord and check out the #🤖-programming channel. The channel is for anything engineering-related!

    • Post work updates in the #🛠-build-in-public. This keeps the team on the same page! Let's avoid stepping on each others toes, minimize blockers / dependencies, and cheer each other on!

    • Ask for someone to review your work or PR in the #🔩-review-requests channel.

  • Watch the repo and bookmark our Project Board. This is the ultimate source of truth for product roadmapping.

  • Learn how to run Athens locally to create a development environment.

  • To start working on your PR, you have a few ways to get started:

    1. Ask a question in our #🤖-programming Discord channel

    2. Comment on one of the existing top-level issues on the project board

    3. Create a PR draft or issue, then assign yourself (prefer drafts over new issues)

  • In all the cases above, try to scope out what you want to do and how, to the extent that you can at the start of a task! If you aren't sure about the scopes, chat in our Discord. If you feel confident, go ahead and start your PR draft — you don't need permission to start!

  • Read Product Development at Athens to see our shipping philosophy. It's more nuanced than just "agile", with some inspiration from Basecamp.

  • If you don't have experience programming with Clojure, checkout our learning resources and join ClojureFam to learn with some friends! In our experience, it takes ~4 weeks of part-time study to begin making solid code contributions to Athens.

Designers

  • Join our Discord and see what's happening in the #🖋-design channel.

  • Duplicate the Athens Design System on Figma to get the building blocks for creating UIs and workflows.

  • See previous concepts in the Product Design Sandbox. This Figma is no longer actively used, but seeing previous work can help!

Documentation

Others

  • Have other superpowers?! Join our Discord, introduce yourself in #🐣-introductions, and ask around in #⛲️-general!

Git and GitHub Style Guide

Commits

Follow guidelines from Conventional Commits. Specifically, begin each commit with one of the following types:

build:
ci:
chore:
docs:
feat:
fix:
perf:
refactor:
revert:
style:
test:

See some real examples in our commit history.

Issues

Please create issues using our templates. However, you will almost certainly get feedback and help faster in our Discord!

Pull Requests

If your PR is related to other issue(s), reference it by issue number. You can close issues smoothly with GitHub keywords:

close #1
fix #2
resolve #2

This repo only allows those with merge permissions to "Squash and Merge" PRs. This makes reverts easier if they are needed.