Mirrors/git-chglog
1
0
Fork 0
mirror of https://github.com/git-chglog/git-chglog.git synced 2026-01-22 18:06:11 +00:00
Code Issues Projects Releases Wiki Activity

docs: Add contributing guide and Issues/PR templates

Browse source
This commit is contained in:
tsuyoshiwada 2018-02-20 23:07:55 +09:00
parent ec0e3c56af
commit ccd72509c6
3 changed files with 113 additions and 0 deletions
Download patch file Download diff file Expand all files Collapse all files

28
.github/ISSUE_TEMPLATE.md vendored Normal file
View file

@ -0,0 +1,28 @@
<!-- Please replace {Please write here} with your description -->
## Expected Behavior
{Please write here}
## Actual Behavior
{Please write here}
## Steps to Reproduce (including precondition)
{Please write here}
## Screenshot on This Problem (if possible)
{Please write here}
## Your Environment
- OS: {Please write here}
- git-chglog version: {Please write here}

35
.github/PULL_REQUEST_TEMPLATE.md vendored Normal file
View file

@ -0,0 +1,35 @@
<!-- Thank you for your contribution to git-chglog! Please replace {Please write here} with your description -->
## What does this do / why do we need it?
{Please write here}
## How this PR fixes the problem?
{Please write here}
## What should your reviewer look out for in this PR?
{Please write here}
## Check lists
* [ ] Test passed
* [ ] Coding style (indentation, etc)
## Additional Comments (if any)
{Please write here}
## Which issue(s) does this PR fix?
<!--
fixes #
fixes #
-->

50
CONTRIBUTING.md Normal file
View file

@ -0,0 +1,50 @@
# Contributing `git-chglog`
Thank you for contributing `git-chglog` :tada:
## Templates
Please use issue/PR templates which are inserted automatically.
## Found a Bug?
If you find a bug in the source code, you can help us by [submitting an issue](https://github.com/git-chglog/git-chglog/issues) to our [GitHub Repository](https://github.com/git-chglog/git-chglog). Even better, you can submit a Pull Request with a fix.
## Commit Message Format
A format influenced by [Angular commit message](https://github.com/angular/angular/blob/master/CONTRIBUTING.md#commit-message-format).
```
<type>: <subject>
<BLANK LINE>
<body>
<BLANK LINE>
<footer>
```
### Type
Must be one of the following:
* **docs:** Documention only changes
* **ci:** Changes to our CI configuration files and scripts
* **chore:** Updating Makefile etc, no production code changes
* **feat:** A new feature
* **fix:** A bug fix
* **perf:** A code change that improves performance
* **refactor:** A code change that neither fixes a bug nor adds a feature
* **style:** Changes that do not affect the meaning of the code
* **test:** Adding missing tests or correcting existing tests
### Footer
The footer should contain a [closing reference to an issue](https://help.github.com/articles/closing-issues-via-commit-messages/) if any.
The **footer** should contain any information about **Breaking Changes** and is also the place to reference GitHub issues that this commit **Closes**.
**Breaking Changes** should start with the word `BREAKING CHANGE:` with a space or two newlines. The rest of the commit message is then used for this.