Thanks for reading our guidelines for contributing to the DOMjudge project. We welcome questions, suggestions, bug reports and pull requests. See below for the preferred ways to report these.
We use the Github issue tracker for bug reports, feature requests and anything in between. Try to provide a clear story, and fill in as much information as possible in our Github issue template. Providing accurate and relevant details will typically speed up the triaging and debugging process.
Note that Github issues are not a good place to ask questions (see below).
Please ask any questions on the DOMjudge-devel mailinglist. Also if you have a problem and you are not 100% sure this is a bug, please first ask/discuss it on the mailinglist.
We also have an IRC channel on the Freenode network: server irc.freenode.net, channel #domjudge. You're welcome to join here and ask questions, provide feedback, or just have a chat. Note that response times may range from a few minutes to hours.
Patches or pull requests for bug fixes or feature enhancements are very much welcomed!
Please try to follow our coding style guidelines.
If you find that the documentation is incorrect, unclear or missing something, then reports or, even better, pull requests are very welcome!
Be aware that when accepting new features, we consider whether the implementation is general and how useful the feature may be to other users; we try balance this with how much a new feature increases code complexity. Also consider making your feature optional using a configuration setting.
If you are interested in starting to contribute to DOMjudge, then the following are some pointers.
First, install and configure the development version of DOMjudge. Either directly from the git reposity, see the developer information section in the admin manual, or via the contributor docker image. If you follow the admin manual for installation, this is also a great way to verify that the documentation is clear and complete, and to report anything that is not.
Start hacking on your own preferred feature(s), or check the list of good first issues. We encourage you to leave a comment on the issue or contact us to let us know you're working on a feature. That way we can suggest good ways to implement it, and whether it would be useful for inclusion in the project. See also submitting pull requests above.