diff options
| author | Misko Hevery | 2011-01-31 11:55:44 -0800 |
|---|---|---|
| committer | Misko Hevery | 2011-02-01 09:58:37 -0800 |
| commit | ed768ebc53ef6746ca83d81892c22d2e9c3afeef (patch) | |
| tree | 2835e5ab21d4700724c28d8bf1178ea13e622eae /docs/guide.contribute.ngdoc | |
| parent | 9fd3dfe49d283c136e29bf60c0da6d4fe2aaed3d (diff) | |
| download | angular.js-ed768ebc53ef6746ca83d81892c22d2e9c3afeef.tar.bz2 | |
Developer guide documentation
Diffstat (limited to 'docs/guide.contribute.ngdoc')
| -rw-r--r-- | docs/guide.contribute.ngdoc | 27 |
1 files changed, 27 insertions, 0 deletions
diff --git a/docs/guide.contribute.ngdoc b/docs/guide.contribute.ngdoc new file mode 100644 index 00000000..9e50e661 --- /dev/null +++ b/docs/guide.contribute.ngdoc @@ -0,0 +1,27 @@ +@workInProgress +@ngdoc overview +@name Developer Guide: Contributing +@description + +# Open Source +Angular is an open source project licensed under the +{@link http://github.com/angular/angular.js/blob/master/LICENSE MIT license}. We welcome any +contributions from the community, but in order to make the contribution process manageable, we ask +you to follow the following guidelines: + +# Source Code +* Discuss any major changes on our {@link http://groups.google.com/group/angular mailing list}. + For small changes and bugfixes, just go ahead and craft your patch and submit it. +* Use coding style described + {@link http://google-styleguide.googlecode.com/svn/trunk/javascriptguide.xml here}. +* To submit any changes, we ask you to use {@link http://github.com} + * Create a github {@link https://github.com/signup/free account} + * Clone the {@link http://github.com/angular/angular.js main angular repository} + * Create a new branch off of the master (`git branch my-fix-branch`) + * Switch to the branch (`git checkout my-fix-branch`), make your changes and commit (`git commit -a`) + * For any new features or regressions we require a test(s) to be submitted with the change + * Run js lint (`rake lint`) and fix any warnings or errors + * Push your branch to github (`git push origin my-fix-branch`) + * Send a pull request via github into `angular:master` + * Once the patch is reviewed and merged, you can delete your branch (`git push origin :my-fix-branch; git checkout master; git branch -D my-fix-branch`) + * TADA! |
