mirror of https://github.com/Hilbis/Hilbish
docs: added CONTRIBUTING.md and a pull request template (#32)
* docs: add CONTRIBUTING.md * docs: add pull request templatepull/38/head
parent
bbfe28dbae
commit
2ecb4c66de
|
@ -0,0 +1,5 @@
|
|||
---
|
||||
- [ ] I have reviewed CONTRIBUTING.md.
|
||||
- [ ] My commits and title use the [Conventional Commit](https://www.conventionalcommits.org/en/v1.0.0/) format.
|
||||
- [ ] I have documented any breaking changes according to [SemVer](https://semver.org/).
|
||||
---
|
|
@ -0,0 +1,10 @@
|
|||
# Contributing
|
||||
|
||||
## Pull Request Process
|
||||
|
||||
1. Ensure that any new install or build dependencies are documented in the README.md and PR request.
|
||||
2. Update the README.md with details of changes to the shell, this includes useful file locations
|
||||
and breaking changes.
|
||||
3. The versioning scheme we use is [SemVer](http://semver.org/) and the commit scheme we use is
|
||||
[Conventional Commits](https://www.conventionalcommits.org/en/v1.0.0/). Please document any
|
||||
backwards incompatible changes and be sure to name your commits correctly.
|
Loading…
Reference in New Issue