How to Contribute
We'd love to accept your patches and contributions to this project. There are just a few small guidelines you need to follow.
Contributor License Agreement
Contributions to this project must be accompanied by a Contributor License Agreement. You (or your employer) retain the copyright to your contribution, this simply gives us permission to use and redistribute your contributions as part of the project. Head over to https://cla.developers.google.com/ to see your current agreements on file or to sign a new one.
You generally only need to submit a CLA once, so if you've already submitted one (even if it was for a different project), you probably don't need to do it again.
Code of Conduct
Participation in this project comes under the Contributor Covenant Code of Conduct
Submitting code via Pull Requests
- We follow the Github Pull Request Model for all contributions.
- For large bodies of work, we recommend creating an issue and labelling it "kind/design" outlining the feature that you wish to build, and describing how it will be implemented. This gives a chance for review to happen early, and ensures no wasted effort occurs.
- For new features, documentation must be included. Review the Documentation Editing and Contribution guide for details.
- All submissions, including submissions by project members, will require review before being merged.
- Once review has occurred, please rebase your PR down to a single commit. This will ensure a nice clean Git history.
- Finally - Thanks for considering submitting code to Agones!
When submitting pull requests, make sure to do the following:
- Format all Go code with gofmt. Many people
use goimports which
fixes import statements and formats code in the same style of
- Remove trailing whitespace. Many editors will do this automatically.
- Ensure any new files have a trailing newline
Build success/failure with relevant details are pushed automatically to pull requests via the not (yet
See the Container Builder documentation for more details on how to edit and expand the build process.
Becoming an Approver on Agones
If you are interested in becoming an Approver on the Agones project and getting commit access to the repository, we have a community membership guide, that outlines the process.
- Kubernetes Custom Resources -
This is how we define our own resource names (
GameServer, etc) within Kubernetes.
- Extend the Kubernetes API with CustomResourceDefinitions - This page shows how to install a custom resource into the Kubernetes API by creating a CustomResourceDefinition.
- Joe Beda's TGIK Controller - Joe Beda did a video series on writing controllers for Kubernetes. This is the best resource for learning about controllers and Kubernetes.
- Kubernetes Sample Controller - Example of a Custom Resources with a Kubernetes Controller.
- Kubernetes Code Generator - The tooling that generated the Go libraries for the Custom Resource we define
- Kubernetes Controller Best Practices - Set of best practices written for writing Controllers inside Kubernetes. Also a great list for everywhere else too.
- Writing Kube Controllers for Everyone - Maciej Szulik, Red Hat - A great intro video into coding for Controllers, and explaining Informers and Listers.
- @markmandel regularly streams his development of Agones on Twitch. You can find the full archive on YouTube
Coding and Development
- How to write a good Git Commit message - Great way to make sure your Pull Requests get accepted.