Contributing
Report bugs, send pull requests, and ask for help from other players.
Bug reports, fixes, translations and docs changes are all welcome. The code is at github.com/Auto-Tournament/auto-tournament.
Report a bug
Open an issue with the Bug Report template. Write:
- what happened, and what you expected,
- the steps to reproduce it,
- your setup: operating system, Docker version and Auto Tournament version.
The version is shown on the login page, and curl http://localhost:3069/api/settings/version prints it.
Other templates: Feature Request, Question, CS2 Server Setup Help, Documentation Issue, Performance Issue and Translation Contribution. If you need several players to test something, or want feedback on a change, use Community Request. People who help with those get credited.
Bugs in the CS2 plugin go to its own repository, and bugs in CS2 Server Manager to that repository.
Send a pull request
Open an issue first for larger changes
For a new feature or a big change, open an issue first, so you know it fits before you write the code.
Set up the code
Fork and clone the repository, and start the dev servers. See Running locally.
Make a branch
git checkout -b fix-veto-timerMake the change
- Keep each pull request to one fix or one feature.
- Follow the code style around your change. Run
yarn lint. - Update the docs if the behaviour changes.
- After you change a route, run
yarn docs:api.
Commit and push
Write commit messages that say what changed and why.
git commit -m "fix(veto): keep the side timer after a page reload"
git push origin fix-veto-timerOpen the pull request
Open a pull request against main. Fill in the template: what it does, the issue it fixes, and how you tested it. CI runs lint, the typecheck, the i18n and API docs checks and the E2E tests.
Questions
Ask in GitHub Discussions or on Discord.
Code of conduct
Be respectful. The details are in CODE_OF_CONDUCT.md.