From d1765663809135476e43d51fed4520c0fb0b10a8 Mon Sep 17 00:00:00 2001 From: Dioni Zhong Date: Thu, 27 May 2021 17:50:50 +0100 Subject: [PATCH] docs: refer contributing to the new location --- CONTRIBUTING.md | 31 +---------------------------- docs/life_cycle_of_a_code_change.md | 12 ----------- 2 files changed, 1 insertion(+), 42 deletions(-) delete mode 100644 docs/life_cycle_of_a_code_change.md diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 94b05bbac..34da7b36e 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -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/ diff --git a/docs/life_cycle_of_a_code_change.md b/docs/life_cycle_of_a_code_change.md deleted file mode 100644 index a92ecc563..000000000 --- a/docs/life_cycle_of_a_code_change.md +++ /dev/null @@ -1,12 +0,0 @@ -# Life cycle of a code change -Once you're confident with the changes implemented in your local branch, you should push them and open a GitHub pull request that can be reviewed and approved. **Note that** this should be a `semantic` pull request (see [semantic release notes](https://github.com/semantic-release/semantic-release)). - -More details about pull request submissions can be found [here](../CONTRIBUTING.md). - -## Development to Staging -* The branch is ready to be merged into the `master` branch when all changes are reviewed and there are no conflicts or blocking errors. -* Commits to master trigger a build on `Travis CI` , which pushes the [rapid-router package](https://pypi.org/project/rapid-router/) to `Pypi`. -* Semaphore CI is notified and deploys it to our staging server, where the code changes will be tested further. - -## Staging to Production -Deployment to production is manually triggered on Semaphore CI. See more details in our deploy app engine [documentation](https://github.com/ocadotechnology/codeforlife-deploy-appengine/blob/master/docs/life-cycle-of-a-code-change.md).