Merge pull request #143 from kasenvr/fix/contributing.md

Update CONTRIBUTING.md
This commit is contained in:
kasenvr 2020-01-31 14:38:35 -05:00 committed by GitHub
commit eb4b264192
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23

View file

@ -1,6 +1,4 @@
The project embraces distributed development and if you'd like to help, we'll pay you -- find out more at [Worklist.net](https://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. The project embraces distributed development and if you'd like to help, it would be greatly appreciated. Just open a pull request with the revisions.
We're hiring! We're looking for skilled developers; send your resume to hiring@highfidelity.io
Contributing Contributing
=== ===
@ -8,7 +6,7 @@ Contributing
2. Clone your fork of the repository locally 2. Clone your fork of the repository locally
``` ```
git clone git://github.com/USERNAME/hifi.git git clone git://github.com/USERNAME/project-athena.git
``` ```
3. Create a new branch 3. Create a new branch
@ -22,15 +20,16 @@ Contributing
6. Update your branch 6. Update your branch
``` ```
git remote add upstream https://github.com/highfidelity/hifi git remote add upstream https://github.com/kasenvr/project-athena
git pull upstream master git pull upstream kasen/core
``` ```
Resolve any conflicts that arise with this step. Resolve any conflicts that arise with this step.
7. Push to your fork 7. Push to your fork
``` ```
git push origin master git push origin kasen/core
``` ```
8. Submit a pull request 8. Submit a pull request
@ -39,10 +38,10 @@ Contributing
Reporting Bugs Reporting Bugs
=== ===
1. Always update to the latest code on master, we make many merges every day and it is possible the bug has already been fixed! 1. Always update to the latest code on master, we make many merges every day and it is possible the bug has already been fixed!
2. Search jobs [on Worklist](https://worklist.net) to make sure that somebody has not already reported the same bug. 2. Search [issues](https://github.com/kasenvr/project-athena/issues) to make sure that somebody has not already reported the same bug.
3. Add a [job on Worklist](https://worklist.net/job/add) including information about your system and how to reproduce the bug. 3. [Add](https://github.com/kasenvr/project-athena/issues/new) your report to the issues list!
Requesting a feature Requesting a Feature
=== ===
1. Search the [the Worklist](https://worklist.net) 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. 1. Search [issues](https://github.com/kasenvr/project-athena/issues) to make sure that somebody has not already requested the same feature.
2. Add a [job on Worklist](https://worklist.net/job/add) that is labeled as a Feature (and select any other appropriate Labels) and includes a detailed description of your request. 2. [Add](https://github.com/kasenvr/project-athena/issues/new) your request to the issues list!