This repository has been archived by the owner on Aug 30, 2021. It is now read-only.
-
Notifications
You must be signed in to change notification settings - Fork 2k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #815 from codydaig/docs/Contributing
Created Contributing.md
- Loading branch information
Showing
1 changed file
with
34 additions
and
0 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,34 @@ | ||
# How to contribute | ||
|
||
Support and contributions from the open source community are essential for keeping | ||
MEAN.js up to date and always improving! There are a few guidelines that we need | ||
contributors to follow to keep the project consistent, as well as allow us to keep | ||
maintaining MEAN.js in a reasonable amount of time. | ||
|
||
## Creating an Issue | ||
|
||
Before you create a new Issue: | ||
* Check the [Issues](https://github.com/meanjs/mean/issues) on Github to ensure one doesn't already exist. | ||
* 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 | ||
|
||
* Create a topic branch from the master branch. | ||
* Check for unnecessary whitespace / changes with `git diff --check` before committing. | ||
* Also check that your code is formatted properly with spaces (hint: Use .editorconfig) | ||
* Keep git commit messages clear and appropriate | ||
* If possible, please "squash" your commits to as few commits as possible/reasonable such as one commit for implementation, one for tests, and one for documentation before finally squashing to one commit when getting the LGTM from a collaborator. | ||
* Make Sure you have added any tests necessary to test your code. | ||
* Run __all__ the tests to ensure nothing else was accidently broken. | ||
* Don't rely on the existing tests to see if you've broken code elsewhere; test the changes you made in a browser too! | ||
* Update the Documentation to go along with any changes in functionality / improvements in a separate pull request against the gh-pages branch. | ||
|
||
## 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 master branch on the MEAN.JS repository. | ||
* Be sure to tag any issues your pull request is taking care of / contributing to. | ||
* By adding "Closes #xyz" to a commit message will auto close the issue once the pull request is merged in. | ||
* Small changes are usually accepted and merged in within a week (provided that 2 collaborators give the okay) | ||
* Larger changes usually spark further discussion and possible changes prior to being merged in. |