overte-JulianGro/CONTRIBUTING.md

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.

Contributing

1. Fork the repository to your own GitHub account.
2. Clone your fork of the repository locally

git clone git://github.com/USERNAME/project-athena.git

3. Create a new branch

git checkout -b new_branch_name 

4. Code

• Follow the coding standard

5. Commit

• Use well formed commit messages

6. Update your branch

git remote add upstream https://github.com/kasenvr/project-athena
git pull upstream master

Resolve any conflicts that arise with this step.

7. Push to your fork

git push origin new_branch_name

8. Submit a pull request

You can follow GitHub's guide to find out how to create a pull request.

Tips for Pull Requests

To make the QA process go as smoothly as possible.

1. Have a basic description in your pull request.
2. Write a basic test plan if added features.
3. If added any new api make sure they come with some documentation included.
4. If accessing any external service make note of how to get a basic setup for these services or what they are based on.

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 issues to make sure that somebody has not already reported the same bug.
3. Add your report to the issues list!

Requesting a Feature

1. Search issues to make sure that somebody has not already requested the same feature.
2. Add your request to the issues list!