When contributing to this repository, please first discuss the change you wish to make via issue, email, forum post or GitHub Discussion before making a change.
Please note we have a code of conduct, please follow it in all your interactions with the project.
- Ensure any install or build dependencies are removed before the end of the layer when doing a build.
- Update the README.md with details of changes to the interface, this includes new environment variables, exposed ports, useful file locations and container parameters.
- Increase the version numbers in any examples files and the README.md to the new version that this Pull Request would represent. The versioning scheme we use is SemVer.
- You may merge the Pull Request in once you have the sign-off of other developers, or if you do not have permission to do that, you may request the second reviewer to merge it for you. A passing CI test is required aswell.
Changes to the API must be incremented with the API_VERSION constant. We use semantic versioning, with each PUSH you must increment the version number depending on the changes you made.
Patch / Bug Fix (Patch Change) = Increment last segment by one e.g. 1.0.0 -> 1.0.1
New Feature (Minor Change) = Increment middle segment by one e.g. 1.0.0 -> 1.1.0 OR 1.4.23 -> 1.5.0
Backwards incompatible Changes (Major Change) = Increment first segment by one e.g. 1.0.0 -> 2.0.0 OR 1.2.12 -> 2.0.0
When your contribution gets accepted and merged into master it is not immediately visible on tosdr.org.
We deploy from the master branch on a weekly basis, meaning somewhere during midnight on Saturday/Sunday our CI automatically deploys changes from the latest approved and passed commit.
When your contribution gets accepted and merged into master it is not immediately visible on the respective stores.
We deploy from the master branch on a monthly basis, meaning somewhere during midnight on Saturday/Sunday our CI automatically deploys changes from the latest approved and passed commit.
When your contribution gets accepted and merged into master it is almost immediately visible on edit.tosdr.org once all CI checks have passed.
Critical security patches will be deployed manually upon merge. If your commit is between the latest deployment commit and security patch it will be deployed as well