-
Notifications
You must be signed in to change notification settings - Fork 44
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
docs(package): update contributing.md, add issue, pull request templates
- Loading branch information
I
committed
Jul 26, 2016
1 parent
39acdfb
commit b8704b9
Showing
5 changed files
with
76 additions
and
24 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,43 @@ | ||
# Contributing to Graffiti-Mongoose | ||
|
||
## Issues: got a question or problem? | ||
|
||
Before you submit your issue search the archive, maybe your question was already answered. | ||
|
||
If your issue appears to be a bug, and hasn't been reported, open a new issue. | ||
Help us to maximize the effort we can spend fixing issues and adding new | ||
features, by not reporting duplicate issues. Providing the following information will increase the | ||
chances of your issue being dealt with quickly: | ||
|
||
- **Overview of the Issue** | ||
- **Reproduce the Error** | ||
- **Related Issues** | ||
- **Suggest a Fix** | ||
|
||
## Submitting a Pull Request | ||
|
||
1. Fork the project | ||
2. Make your changes in a new git branch: | ||
|
||
```shell | ||
git checkout -b fix/my-branch master | ||
``` | ||
3. Commit your changes using a descriptive commit message that follows the [Angular commit message format](https://github.com/angular/angular.js/blob/master/CONTRIBUTING.md#commit-message-format) | ||
|
||
```shell | ||
git commit -a | ||
``` | ||
4. Push your branch to GitHub: | ||
|
||
```shell | ||
git push origin fix/my-branch | ||
``` | ||
5. In GitHub, send a pull request to `master` | ||
|
||
General checklist: | ||
- [ ] tests must pass | ||
- [ ] follow existing coding style | ||
- [ ] if you add a feature, add documentation to `README` | ||
- [ ] if you fix a bug, add a test | ||
|
||
#### Thank you for your contribution! |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,29 @@ | ||
## Overview of the Issue | ||
|
||
Give a short description of the issue. | ||
|
||
```javascript | ||
If an error was thrown, paste here the stack trace. | ||
``` | ||
|
||
## Reproduce the Error | ||
|
||
Provide an unambiguous set of steps, Node version, package version, etc. | ||
|
||
Steps to reproduce: | ||
1. step | ||
2. step | ||
3. step | ||
|
||
Node version: `x.x.x` | ||
Graffiti version: `x.x.x` | ||
|
||
## Related Issues | ||
|
||
Has a similar issue been reported before? | ||
|
||
## Suggest a Fix | ||
|
||
If you can't fix the bug yourself, perhaps you can point to what might be causing the problem (line of code or commit) | ||
|
||
### Thank you for your contribution! |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,3 @@ | ||
Before sending a pull-request please open an issue to discuss new features or non-trivial changes. | ||
|
||
### Thank you for your contribution! |
This file was deleted.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters