Mirrors/overte-HifiExperiments
3
0
Fork 0
mirror of https://github.com/HifiExperiments/overte.git synced 2025-04-06 09:43:17 +02:00
Code Issues Projects Releases Packages Wiki Activity Actions

add some more information to the CONTRIBUTING guide

Browse source
This commit is contained in:
Stephen Birarda 2014-03-05 16:22:38 -08:00
parent 53da23cdf0
commit 4857268ab7
1 changed files with 39 additions and 1 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

40
CONTRIBUTING.md
View file

@ -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
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.