Skip to content

Commit

Permalink
Separate actual style guides from procedures
Browse files Browse the repository at this point in the history
  • Loading branch information
adzialocha authored and louilinn committed Feb 2, 2021
1 parent 7a8efe6 commit 1bddab3
Showing 1 changed file with 22 additions and 3 deletions.
25 changes: 22 additions & 3 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,10 @@

## :sloth: Styleguide

### Code

* All repositories have linters in place which help you to follow the recommended style guidelines for formatting code. Read in the according `README.md` of the repository to find out how to run the linter tasks.

### Commit Messages

* Capitalize the first line and each paragraph
Expand All @@ -15,14 +19,29 @@ Check out the [guidelines for commit messages](https://gist.github.com/robertpai

### Branches

* `main` contains only reviewed, tested and released code
* You can not push directly to `main`, create a branch with your changes and open a PR to request code review before merging
* Follow simple branch naming scheme clearly describing the topic (e.g., `refactor-authentication`, `make-retina-avatars`)
* Follow a simple naming scheme clearly describing the topic (e.g., `refactor-authentication`, `make-retina-avatars`) you are working on

### Pull Requests

* Use the description field to describe what you are introducing or changing in your branch
* You can [add TODO lists](https://docs.github.com/en/github/managing-your-work-on-github/about-task-lists) in the description field
* Mention related issues in the description field by writing `Closes #<issue no>`. This will [automatically close the issue](https://github.blog/2013-01-22-closing-issues-via-commit-messages/) when your contribution got merged

## :turtle: How to ..

### Merge branches

* You can not push directly to `main`, please create a branch with your changes and open a PR to request code review before merging
* Change the PR to ["Draft" state](https://github.blog/2019-02-14-introducing-draft-pull-requests/) if your work is not done yet
* Make sure you followed the [Styleguide](#Styleguide) and linter recommendations
* Verify that all status checks are passing
* Click "Ready to Review" to request merging your branch into `main`
* Merges require the approval of at least one core maintainer. The reviewer(s) may ask you to complete additional design work, tests, or other changes before your pull request can be finally accepted

### Release new versions

* All releases follow the [semantic versioning scheme](https://semver.org/)
* The `main` branch should contain only tested, reviewed and released code
* `staging` branch should contain code that is compiled and run on the Circles staging servers
* Release additions, updates, fixes and breaking changes are always documented in `CHANGELOG.md` following this [scheme](https://keepachangelog.com)
* Release commits are tagged via git and additionally maintained as GitHub releases

0 comments on commit 1bddab3

Please sign in to comment.