joyent-portal/CONTRIBUTING.md

50 lines
1.3 KiB
Markdown
Raw Normal View History

2016-10-14 14:25:04 +03:00
## Development Workflow
### Small Feature Development
2017-10-12 21:15:51 +03:00
Contributors who have write access to the repository will practice continuous
2016-10-14 14:25:04 +03:00
delivery (CD as known from now on in this document).
2017-10-12 21:15:51 +03:00
We will define CD in this document as a method of developing a feature per
commit with an encapsulating test that proves that the functionality is working,
the contributor will test their code locally and if all is passing will push to
2017-11-16 13:58:56 +02:00
_master_.
2016-10-14 14:25:04 +03:00
2017-10-12 21:15:51 +03:00
For contributors that do not have write access, follow the same conventions but
2016-10-14 14:25:04 +03:00
open a Pull Request instead.
### Large changesets
2017-10-12 21:15:51 +03:00
When larger changes need to be made, or the work that is carried out spans
multiple components / services of the application at the same time a single
commit will not suffice.
2016-10-14 14:25:04 +03:00
In this scenario, the contributor should open a pull request instead.
## Commit messages
2017-11-16 13:58:56 +02:00
Follow [Git blessed](http://chris.beams.io/posts/git-commit/) and
[Conventional Commits](https://conventionalcommits.org)
2016-10-14 14:25:04 +03:00
2018-02-28 00:40:51 +02:00
1. Separate subject from body with a blank line
1. Limit the subject line to 50 characters
1. Capitalize the subject line
1. Do not end the subject line with a period
1. Use the imperative mood in the subject line
1. Wrap the body at 72 characters
1. Use the body to explain what and why vs. how
2017-10-12 21:15:51 +03:00
Types:
2017-11-16 13:58:56 +02:00
* build
* chore
* ci
* docs
* feat
* fix
* perf
* refactor
* revert
* style
* test