78 lines
No EOL
5.3 KiB
Markdown
78 lines
No EOL
5.3 KiB
Markdown
# Contributing
|
|
|
|
When contributing to this repository, please first discuss the change you wish to make via issue,
|
|
email, or any other method with the owners of this repository before making a change.
|
|
|
|
Please note we have a code of conduct, please follow it in all your interactions with the project.
|
|
|
|
## Pull Request Process
|
|
|
|
1. Follow the guidelines for making a commit. If the guidelines aren't followed your pull request will be closed.
|
|
2. Ensure any install or build dependencies are removed before the end of the layer when doing a build.
|
|
3. Update the README.md with details of changes to the interface, this includes new environment variables, exposed ports, useful file locations and container parameters.
|
|
4. Increase the version numbers in any examples files and the README.md to the new version that this pull request would represent. The versioning scheme we use is [SemVer](http://semver.org/).
|
|
5. You may merge the Pull Request in once you have the sign-off of two other developers, or if you
|
|
do not have permission to do that, you may request the second reviewer to merge it for you.
|
|
|
|
## Commit Guidelines
|
|
|
|
| Commit type | Emoji |
|
|
|:----------------------------|:----------------------------------------------------------|
|
|
| Version tag | :bookmark: `:bookmark:` |
|
|
| New feature | :sparkles: `:sparkles:` |
|
|
| Bugfix | :bug: `:bug:` |
|
|
| Metadata | :card_index: `:card_index:` |
|
|
| Documentation | :books: `:books:` |
|
|
| Documenting source code | :bulb: `:bulb:` |
|
|
| Performance | :racehorse: `:racehorse:` |
|
|
| Cosmetic | :lipstick: `:lipstick:` |
|
|
| Tests | :rotating_light: `:rotating_light:` |
|
|
| Adding a test | :white_check_mark: `:white_check_mark:` |
|
|
| Make a test pass | :heavy_check_mark: `:heavy_check_mark:` |
|
|
| General update | :zap: `:zap:` |
|
|
| Improve format/structure | :art: `:art:` |
|
|
| Refactor code | :hammer: `:hammer:` |
|
|
| Removing code/files | :fire: `:fire:` |
|
|
| Continuous Integration | :green_heart: `:green_heart:` |
|
|
| Security | :lock: `:lock:` |
|
|
| Upgrading dependencies | :arrow_up: `:arrow_up:` |
|
|
| Downgrading dependencies | :arrow_down: `:arrow_down:` |
|
|
| Lint | :shirt: `:shirt:` |
|
|
| Translation | :alien: `:alien:` |
|
|
| Text | :pencil: `:pencil:` |
|
|
| Critical hotfix | :ambulance: `:ambulance:` |
|
|
| Deploying stuff | :rocket: `:rocket:` |
|
|
| Work in progress | :construction: `:construction:` |
|
|
| Adding CI build system | :construction_worker: `:construction_worker:` |
|
|
| Analytics or tracking code | :chart_with_upwards_trend: `:chart_with_upwards_trend:` |
|
|
| Removing a dependency | :heavy_minus_sign: `:heavy_minus_sign:` |
|
|
| Adding a dependency | :heavy_plus_sign: `:heavy_plus_sign:` |
|
|
| Docker | :whale: `:whale:` |
|
|
| Configuration files | :wrench: `:wrench:` |
|
|
| NodeJS package.json | :package: `:package:` |
|
|
| Merging branches | :twisted_rightwards_arrows: `:twisted_rightwards_arrows:` |
|
|
| Bad code / need improv. | :hankey: `:hankey:` |
|
|
| Reverting changes | :rewind: `:rewind:` |
|
|
| Breaking changes | :boom: `:boom:` |
|
|
| Code review changes | :ok_hand: `:ok_hand:` |
|
|
| Accessibility | :wheelchair: `:wheelchair:` |
|
|
| Move/rename repository | :truck: `:truck:` |
|
|
| Issue/Pull Request template | :newspaper_roll: `:newspaper_roll:` |
|
|
| Merge pull request | :knot: `:knot:` |
|
|
| Assets | :bento: `:bento:` |
|
|
|
|
### Format
|
|
|
|
Your commit messages should use the following as a guide:
|
|
```
|
|
[emoji] description
|
|
```
|
|
|
|
This is an example of this being used for "**Assets**":
|
|
```
|
|
[🍱] Added terminal.png
|
|
```
|
|
|
|
## Code of Conduct
|
|
|
|
Our Code of Conduct is located at `CODE_OF_CONDUCT.md` |