Rumperuu/footnotes
Archived
1
0
Fork 0
Code Issues Pull requests Projects Releases Wiki Activity

chore: add php-commitizen (#76)

Browse source 
Adds PHP Commitizen for automated commit message formatting.

fix #39
This commit is contained in:
Ben Goldsworthy 2021-04-12 21:14:13 +01:00 • committed by GitHub
parent 50115fb6c9
commit 5fa3e1403e
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
5 changed files with 180 additions and 12 deletions
Download patch file Download diff file Expand all files Collapse all files

26
CONTRIBUTING.md
View file

@ -5,33 +5,39 @@ request the best chance of being accepted:
# Requesting Features/Reporting Bugs
- To request a new feature or to report a bug, create an
[Issue](https://github.com/markcheret/footnotes/issues/new/choose) and choose
the correct template
- To request a new feature or to report a bug, create an [Issue][new-issue] and
choose the correct template
# Contributing Code
- **footnotes** uses [GitHub Flow](https://githubflow.github.io/)
- **footnotes** uses [GitHub Flow][github-flow]
- branch off of `main` to start developing (`git checkout -b <your branch>`)
- ensure that your new branch has a descriptive name
- create a remote copy of your new branch (`git push`)
- create a draft [pull request](https://github.com/markcheret/footnotes/compare)
to merge your branch with `main` — tag any related Issues, and if they are
assigned to a Project board, this will automatically move them into the
‘In Progress’ bucket
- create a draft [pull request][pull-request] to merge your branch with `main` —
tag any related Issues, and if they are assigned to a Project board, this will
automatically move them into the ‘In Progress’ bucket
- when you think you're finished, un-draft your pull request — if the PR is
assigned to a Project board, this will automatically move it and any related
Issues into the ‘Review in progress’ bucket
# Commits
- **footnotes** uses [Conventional Commits](https://www.conventionalcommits.org)
- **footnotes** uses [Conventional Commits][conventional-commits]
- we use [PHP Commitizen][php-commitizen] to automate this - use `composer commit`
- keep individual commits as small as possible
# Versioning
- **footnotes** uses [Semantic Versioning](https://semver.org/)
- **footnotes** uses [Semantic Versioning][semver]
# Translating
- Translations are welcome!
[new-issue]: https://github.com/markcheret/footnotes/issues/new/choose
[github-flow]: https://githubflow.github.io/
[pull-request]: https://github.com/markcheret/footnotes/compare
[conventional-commits]: https://www.conventionalcommits.org
[php-commitizen]: https://github.com/conventional-commits/php-commitizen
[semver]: https://semver.org/