diff options
| author | Naomi Black | 2013-12-02 16:23:59 -0800 |
|---|---|---|
| committer | Naomi Black | 2013-12-02 16:23:59 -0800 |
| commit | 5a8d9acacbb8a2b9175da196cbaf8ff93bac28c8 (patch) | |
| tree | e39334700fbd7132273bdee69914dd8278408cbe /CONTRIBUTING.md | |
| parent | 04d5a5072fe45d5aa8ec9c027bae9d29ee56c2d1 (diff) | |
| download | angular.js-5a8d9acacbb8a2b9175da196cbaf8ff93bac28c8.tar.bz2 | |
docs: update CONTRIBUTING.MD with process for doc fixes
Diffstat (limited to 'CONTRIBUTING.md')
| -rw-r--r-- | CONTRIBUTING.md | 12 |
1 files changed, 12 insertions, 0 deletions
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index ef0e7cc5..3c34dd03 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -29,6 +29,18 @@ duplication of work, and help you to craft the change so that it is successfully project. * **Small Changes** can be crafted and submitted to [GitHub Repository][github] as a Pull Request. + +## Want a Doc Fix? +If you want to help improve the docs, it's a good idea to let others know what you're working on to +minimize duplication of effort. Before starting, check out the issue queue for [Milestone:Docs Only with label type:docs](https://github.com/angular/angular.js/issues?labels=type%3A+docs&milestone=24&state=open). +Comment on an issue to let others know what you're working on, or create a new issue if your work +doesn't fit within the scope of any of the exisitng doc fix projects. + +For large fixes, please build and test the documentation before submitting the PR to be sure you haven't +accidentally introduced any layout or formatting issues. + +If you're just making a small change, don't worry about filing an issue first. Use the friendly blue "Improve this doc" button at the top right of the doc page to fork the repository in-place and make a quick change on the fly. + ## Submission Guidelines ### Submitting an Issue |