Skip to content

Commit 5330d71

Browse files
authored
Add contributing guidelines
1 parent 73c5d52 commit 5330d71

File tree

1 file changed

+19
-0
lines changed

1 file changed

+19
-0
lines changed

CONTRIBUTING.md

+19
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
# Contributing to Power Tab Editor
2+
3+
- First time contributing? Read our [Code of Conduct](https://github.com/powertab/powertabeditor/blob/master/CODE_OF_CONDUCT.md).
4+
- Check out the [project overview](https://github.com/powertab/powertabeditor/wiki/Power-Tab-Editor-2.0,-Here-at-last!) to learn more about the project.
5+
6+
## Testing
7+
8+
- Install the latest release from the [downloads page](https://github.com/powertab/powertabeditor/releases)!
9+
- You can report bugs or suggest features on the [issue tracker](https://github.com/powertab/powertabeditor/issues).
10+
- A great way to assist with improving the program is to open tabs that were created in other applications (`.ptb`, `.gpx`, etc) and report any issues with how they are imported, displayed, or play back!.
11+
12+
## Development
13+
14+
- Code contributions are very welcome!
15+
- The [README](https://github.com/powertab/powertabeditor/blob/master/README.md) has instructions for how to set up your development environment.
16+
- You can look through the [issue tracker](https://github.com/powertab/powertabeditor/issues) for some bugs or features that can be worked on, or suggest your own improvements!
17+
- Feel free to open an issue or a draft pull request if you'd like to get early feedback on some proposed changes, or reach out to the maintainers directly.
18+
- It's encouraged to use our [clang-format](https://github.com/powertab/powertabeditor/blob/master/.clang-format) configuration file to format the code, if it's supported by your editor.
19+
- If your changes are in an area of the codebase that's suitable for unit testing (i.e. not related to audio playback or rendering), it's encouraged to add [unit tests](https://github.com/powertab/powertabeditor/tree/master/test).

0 commit comments

Comments
 (0)