eqMac/CONTRIBUTING.md

Contributing Guide

---

Submitting Issues (Bug reports)

If you found a bug in eqMac2, please follow these steps to properly report it:

1. Sign-up / Log-in to GitHub
2. Go to Issues tab and make sure your issue was not reported yet
3. If issue wasn't reported yet, create a new one.
4. Set the Label (on the right) to Bug or any other appropriate
5. Describe the Bug as much as possible
6. If possible include some Screenshots

Contributing your code

1. First, create an Issue with an 'enchancement' or 'bug' label
2. Before doing any work, wait for someone to approve or discuss the issue
3. Once work has been approved and/or coordinated, fork the repository
4. Write code in your Forked repository. Make sure to properly comment complex solutions
5. Once you are happy with your code, test it until no bugs are prevelant.
6. Submit a New Pull Request and wait for someone to review it.