mirror of
https://github.com/overte-org/overte.git
synced 2025-04-14 11:07:10 +02:00
48 lines
2 KiB
Markdown
48 lines
2 KiB
Markdown
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.
|
|
|
|
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://docs.highfidelity.com/build-guide/coding-standards)
|
|
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
|
|
```
|
|
8. Submit a pull request
|
|
|
|
*You can follow [GitHub's guide](https://help.github.com/articles/creating-a-pull-request) to find out how to create a pull request.*
|
|
|
|
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!
|
|
2. Search jobs [on Worklist](https://worklist.net) 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.
|
|
|
|
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.
|
|
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.
|