From 4857268ab73980609d5c5c785b5889c24150db67 Mon Sep 17 00:00:00 2001 From: Stephen Birarda Date: Wed, 5 Mar 2014 16:22:38 -0800 Subject: [PATCH] add some more information to the CONTRIBUTING guide --- CONTRIBUTING.md | 40 +++++++++++++++++++++++++++++++++++++++- 1 file changed, 39 insertions(+), 1 deletion(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 9a62fbda57..171b1274b8 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -1,3 +1,41 @@ The project embraces distributed development and if you'd like to help, we'll pay you -- find out more at Worklist.net. If you find a small bug and have a fix, pull requests are welcome. If you'd like to get paid for your work, make sure you report the bug via a job on Worklist.net. -We're hiring! We're looking for skilled developers; send your resume to hiring@highfidelity.io \ No newline at end of file +We're hiring! We're looking for skilled developers; send your resume to hiring@highfidelity.io + +Contributing +=== +1. Fork the repository to your own GitHub account. +2. Clone your fork of the repository locally + ``` + git clone git://github.com/USERNAME/hifi.git + ``` +3. Create a new branch + ``` + git checkout -b new_branch_name + ``` +4. Code + * Follow the [coding standard](https://github.com/highfidelity/hifi/wiki/Coding-Standard) +5. Commit + * Use [well formed commit messages](http://tbaggery.com/2008/04/19/a-note-about-git-commit-messages.html) +6. Update your branch + ``` + git remote add upstream https://github.com/highfidelity/hifi + git pull upstream master + ``` + + Resolve any conflicts that arise with this step. +7. Push to your fork + ``` + git push origin master + ``` + +Reporting Bugs +=== +1. Always update to the latest code on master, it is possible the bug has already been fixed! +2. Search the [repository issues](https://github.com/highfidelity/hifi/issues) to make sure that somebody has not already reported the same bug. +3. Open an [issue on GitHub](https://github.com/highfidelity/hifi/issues) including information about your system and how to reproduce the bug. + +Requesting a feature +=== +1. Search the [repository issues](https://github.com/highfidelity/hifi/issues) to make sure that somebody has not already requested the same feature. If you find a matching request, feel free to add any additional comments to the existing issue. +2. Submit an [issue on GitHub](https://github.com/highfidelity/hifi/issues) that is tagged as a feature. \ No newline at end of file