Welcome to the Athens project! We are a proxy server for the Go Modules download API.
 Developer Meetings |
|---|
| We hold weekly developer meetings on a Thursday, to join them, watch previous meeting recordings or find more information, please see the docs. Absolutely everyone is invited to attend these, suggest topics, and participate! |
See our documentation site https://docs.gomods.io for more details on the project.
Project Athens is in alpha. Things might change, so we recommend that you don't run it for production workloads. We have organizations that are testing it internally, and there is an experimental public proxy server running.
We encourage you to test it out and contribute when you can!
Although the project is alpha, here's where we're going:
The proxy implements the Go modules download protocol.
There is currently an experimental public proxy, and we have plans to host a more stable public proxy with more guarantees. We also have a community of folks who are testing Athens inside their organizations, as an "internal proxy." In either deployment, users set their GOPROXY environment variable to point to the Athens proxy of their choice. At that point, go get, go build, and go builds will use the proxy to download dependencies as necessary.
Athens proxies are highly configurable, so they can work for lots of different deployments. For example, public proxies can store code in cloud databases and CDNs, while internal "enterprise" deployments can use disk-based (i.e. NFS) storage.
See DEVELOPMENT.md for details on how to set up your development environment and start contributing code.
Speaking of contributing, read on!
This project is early and there's plenty of interesting and challenging work to do.
If you find a bug or want to fix a bug, we ❤️ PRs and issues! If you see an issue in the queue that you'd like to work on, please just post a comment saying that you want to work on it. Something like "I want to work on this" is fine.
If you decide to contribute (we hope you do 😄), the process is familiar and easy if you've used Github before. There are no long documents to read or complex setup. If you haven't used Github before, the awesome @bketelsen has created a good overview on how to contribute code - see here.
Before you do start contributing or otherwise getting involved, we want to let you know that we follow a general philosophy in how we work together, and we'd really appreciate you getting familiar with it before you start.
It's not too long and it's ok for you to "skim" it (or even just read the first two sections 😄), just as long as you understand the spirit of who we are and how we work.
If you're not ready to contribute code yet, there are plenty of other great ways to get involved:
- Come talk to us in the
#athenschannel in the Gophers slack. We’re a really friendly group, so come say hi and join us! Ping me (@arschleson slack) in the channel and I’ll give you the lowdown - Come to our weekly development meetings! They are a great way to meet folks, ask questions, find some stuff to work on, or just hang out if you want to. Just like with this project, absolutely everyone is welcome to join and participate in those
- Get familiar with the system. There's lots to read about. Here are some places to start:
- Gentle Introduction to the Project - the basics of why we started this project
- The Download Protocol - the core API that the proxy implements and the
goCLI uses to download packages - Proxy Design - what the proxy is and how it works
- Go modules wiki - context and details on how Go dependency management works in general
- "Go and Versioning" - long articles on Go dependency management details, internals, etc...
The Athens project would not be possible without the amazing projects it builds on. Please see SHOULDERS.md to see a list of them.
We all strive to write nice and readable code which can be understood by every person of the team. To achieve that we follow principles described in Brian's talk Code like the Go team.
This project follows the Contributor Covenant (English version here) code of conduct.
If you have concerns, notice a code of conduct violation, or otherwise would like to talk about something
related to this code of conduct, please reach out to me, Aaron Schlesinger on the Gophers Slack. My username is arschles. Note that in the future, we will be expanding the
ways that you can contact us regarding the code of conduct.
Athens banner attributed to Golda Manuel