-
Notifications
You must be signed in to change notification settings - Fork 83
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
docs: refer contributing to the new location
- Loading branch information
Showing
2 changed files
with
1 addition
and
42 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,30 +1 @@ | ||
# Contributing Guidelines | ||
|
||
Thanks for helping out Code For Life's Rapid Router! Here are a few guidelines to help your contributions to be accepted :) | ||
|
||
## Tracking Issues | ||
|
||
We use Zenhub to track our issues, you can find [our workspace here](https://github.com/ocadotechnology/rapid-router#workspaces/code-for-life-development-56f2afba6e54555c586f6db3/board?repos=39072690,22154147,18399425,49142916,219226351). | ||
We recommend to add [Zenhub chrome extension](https://www.zenhub.com/extension) to integrate directly into Github's user interface. | ||
|
||
## Submitting a bug report or a feature request | ||
|
||
If you find a bug or want to suggest a feature request or improvement, please open an issue for it using one of the issue templates. | ||
|
||
> One word of caution: please do not add any issues related to security. Evil hackers are everywhere nowadays... If you do find a security issue, let us know using our contact form [on the website][c4l] (scroll down and click `Contact us`). | ||
## Pull Request Guidelines | ||
|
||
Once you submit a PR, we will review it via [Reviewable](https://reviewable.io/). To make the review go smoothly we recommend following the guidelines below: | ||
|
||
- Include unit tests when you contribute new features, as they help to a) prove that your code works correctly, and b) guard against future breaking changes to lower the maintenance cost. | ||
|
||
- Bug fixes also generally require unit tests, because the presence of bugs usually indicates insufficient test coverage. | ||
|
||
- Use the [black formatter](https://black.readthedocs.io/en/stable/installation_and_usage.html) on your code. | ||
|
||
- When you respond to changes based on comments from a code review, please reply with "Done." so that we get a notification. | ||
|
||
We follow [Semantic Versioning](https://semver.org/) in this project. The version automatically gets bumped up based on the content of the PR title and description. For this we follow the [Conventional Commits Specification](https://www.conventionalcommits.org). Please make sure the PR title and description follows this specification. | ||
|
||
[c4l]: https://www.codeforlife.education/ | ||
Please review our contributing documentation at https://docs.codeforlife.education/ |
This file was deleted.
Oops, something went wrong.