Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Create CONTRIBUTING.md #415

Merged
merged 1 commit into from
Jan 6, 2024
Merged

Create CONTRIBUTING.md #415

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
24 changes: 24 additions & 0 deletions CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
# How to contribute

Please review the following guidelines before contributing.

## Testing

Tests are encouraged when practical. All pull requests will run tests and test for successful Docker builds.

## Submitting changes

Please use the branch naming format `v0.0.0` - the branch name should simply be the version you are creating.

Please use semantic versioning for determining the next version number.

Please title the pull request `Release v0.0.0 - Title`. For example: `Release v1.2.3 - New feature doing this cool thing.`

Open a pull request with your proposed changes.

Please fill out the pull request template and use a list to describe your changes.

## Coding conventions

* Indent using 4 spaces
* Format using `black`
Loading