GitHub is the current version control repository used to maintain the Odamex source code. In layman's terms, it allows multiple people to be working on the same project at the same time while giving those same people the facilities to recognize collisions between two contributors code.

Odamex's GitHub repository can be accessed using the following URL:

https://github.com/odamex/odamex

Read-only access to Odamex's GitHub repository is public, meaning that anyone can checkout the source for their own purposes, including modification and compilation. However, further repository access, such as Commit access, is restricted based on access permissions. If you wish to contribute to Odamex, you can do this by submitting pull requests. Those that contribute considerable time to improve the Odamex source may be granted full or partial access.

Generally, the project manager(s) will administrate this access with the guidance of the lead coder(s). Inactive accounts will tend to get frozen or disabled after a certain length of time.

TO DO: How to use GitHub and download the source. For now you can download the latest version of the source as a zip file under the green button labelled "Clone or download"

Any changes to our GitHub repository are reported in:

• Changes to Odamex's stable branch on GitHub
• The #github-commits channel in the Odamex Discord server

Do

• Regularly update your working copy
• Commit individual improvements and corrections to the existing code
• Separate your commits semantically
• Make an informative comment with each commit
• Mention related bugs and revisions (see https://github.com/odamex/odamex/commits/stable/ for examples)
• Before making major changes, check Pull requests to see if a feature or bug/issue you're working on is already being addressed, or visit the #oda-development channel in the Odamex Discord server
• Test your changes before every commit

Do not

• Commit broken code to trunk or stable
• Commit untested code to stable
• Make giant monolithic commits
• Make major changes without consulting maintainers
• Make frivolous commits
• Overwrite other people's recent work without asking them
• Change EOL modes of files—all files should be LF