Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
4101b1b
commit c9485b0
Showing
3 changed files
with
76 additions
and
11 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 |
---|---|---|
@@ -1,36 +1,38 @@ | ||
Contributing | ||
--------------------------------- | ||
### How to contribute | ||
# Contributing | ||
|
||
## How to contribute | ||
|
||
Support and contributions from the open source community are essential for keeping | ||
Mean Stack JS up to date. We are always looking for the quality contributions and | ||
will be happy to accept your Pull Requests as long as those adhere to some basic rules: | ||
|
||
* Please make sure that your contribution fits well in the project's style & concept: | ||
* JS Standard | ||
* John Papa angular style guide | ||
* Pass All Test | ||
* [Standard JS](http://standardjs.com/) | ||
* [John Papa Angular Style](https://github.com/johnpapa/angular-styleguide/tree/master/a1) | ||
* [Pass All Test](https://travis-ci.org/greenpioneersolutions/meanstackjs) | ||
* [Roadmap](https://github.com/greenpioneersolutions/meanstackjs/wiki/Roadmap) | ||
|
||
### Creating an Issue | ||
## Creating an Issue | ||
|
||
Before you create a new Issue: | ||
* Check the [Issues](https://github.com/greenpioneersolutions/meanstackjs/issues) on Github to ensure one doesn't already exist. | ||
* Place use one of these topics in the beginning of your issue title- Contrib, Hotfix, Error, Help or Feature. | ||
* Clearly describe the issue, including the steps to reproduce the issue. | ||
* If it's a new feature, enhancement, or restructure, Explain your reasoning on why you think it should be added, as well as a particular use case. | ||
|
||
### Making Changes | ||
## Making Changes | ||
|
||
* Create a topic branch from the development branch with the issue number EX. `#200_make_changes` | ||
* Use `standard` to verify your style - `npm install -g standard` if you dont have it already | ||
* Use `standard || npm run standard` to verify your style - `npm install -g standard` if you dont have it already | ||
* Keep git commit messages clear and appropriate | ||
* Make Sure you have added any tests necessary to test your code. `npm test` | ||
* Update the Documentation to go along with any changes in functionality / improvements in a separate pull request against the gh-pages branch. | ||
* Update the Documentation to go along with any changes in functionality / improvements. | ||
|
||
### Submitting the Pull Request | ||
## Submitting the Pull Request | ||
|
||
* Push your changes to your topic branch on your fork of the repo. | ||
* Submit a pull request from your topic branch to the development branch | ||
* We use [GitFlow](https://guides.github.com/introduction/flow/) | ||
* Be sure to tag any issues your pull request is taking care of / contributing to. EX. `#201 add and updated this` | ||
* By adding "Closes #xyz" to a commit message will auto close the issue once the pull request is merged in. | ||
|
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,32 @@ | ||
<!--- Provide a general summary of the issue in the Title above --> | ||
|
||
## Expected Behavior | ||
<!--- If you're describing a bug, tell us what should happen --> | ||
<!--- If you're suggesting a change/improvement, tell us how it should work --> | ||
|
||
## Current Behavior | ||
<!--- If describing a bug, tell us what happens instead of the expected behavior --> | ||
<!--- If suggesting a change/improvement, explain the difference from current behavior --> | ||
|
||
## Possible Solution | ||
<!--- Not obligatory, but suggest a fix/reason for the bug, --> | ||
<!--- or ideas how to implement the addition or change --> | ||
|
||
## Steps to Reproduce (for bugs) | ||
<!--- Provide a link to a live example, or an unambiguous set of steps to --> | ||
<!--- reproduce this bug. Include code to reproduce, if relevant --> | ||
1. | ||
2. | ||
3. | ||
4. | ||
|
||
## Context | ||
<!--- How has this issue affected you? What are you trying to accomplish? --> | ||
<!--- Providing context helps us come up with a solution that is most useful in the real world --> | ||
|
||
## Your Environment | ||
<!--- Include as many relevant details about the environment you experienced the bug in --> | ||
* Version used: | ||
* Environment name and version (e.g. Chrome 39, node.js 5.4): | ||
* Operating System and version (desktop or mobile): | ||
* Link to your project: |
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,31 @@ | ||
<!--- Provide a general summary of your changes in the Title above --> | ||
|
||
## Description | ||
<!--- Describe your changes in detail --> | ||
|
||
## Motivation and Context | ||
<!--- Why is this change required? What problem does it solve? --> | ||
<!--- If it fixes an open issue, please link to the issue here. --> | ||
|
||
## How Has This Been Tested? | ||
<!--- Please describe in detail how you tested your changes. --> | ||
<!--- Include details of your testing environment, and the tests you ran to --> | ||
<!--- see how your change affects other areas of the code, etc. --> | ||
|
||
## Screenshots (if appropriate): | ||
|
||
## Types of changes | ||
<!--- What types of changes does your code introduce? Put an `x` in all the boxes that apply: --> | ||
- [ ] Bug fix (non-breaking change which fixes an issue) | ||
- [ ] New feature (non-breaking change which adds functionality) | ||
- [ ] Breaking change (fix or feature that would cause existing functionality to change) | ||
|
||
## Checklist: | ||
<!--- Go over all the following points, and put an `x` in all the boxes that apply. --> | ||
<!--- If you're unsure about any of these, don't hesitate to ask. We're here to help! --> | ||
- [ ] My code follows the code style of this project. | ||
- [ ] My change requires a change to the documentation. | ||
- [ ] I have updated the documentation accordingly. | ||
- [ ] I have read the **CONTRIBUTING** document. | ||
- [ ] I have added tests to cover my changes. | ||
- [ ] All new and existing tests passed. |