CONTRIBUTING.md (3164B)
1 # Contributing to ChowTape 2 3 The goal of this project is to create a high-quality, 4 open-source tape emulation plugin. Here's how you can 5 help: 6 7 8 ## Testing 9 10 The easiest way to contribute is to simply use the plugin! 11 All software has bugs, so the more folks using the software, 12 the quicker bugs will be found and fixed! For audio plugins 13 in particular, there are different DAWs, versions, etc, 14 that can all have different behavior, triggering different bugs. 15 Testing with the [Nightly Builds](https://chowdsp.com/nightly.html#tape) 16 is especially appreciated, to help catch bugs before they make 17 it into an official release. The 18 [issues](https://github.com/jatinchowdhury18/AnalogTapeModel/issues) 19 page can be used for reporting bugs or posting feature requests. 20 All feedback is useful and most welcome! 21 22 23 ## Presets 24 25 If you have a favorite setting for the plugin, consider 26 adding it as a preset so other users can try it as well! 27 For more information on contributing presets, see the 28 [presets issue](https://github.com/jatinchowdhury18/AnalogTapeModel/issues/30). 29 30 31 ## Documentation 32 33 If you've been using the plugin for a while and are pretty 34 familiar with it, please consider contributing to the plugin 35 [documentation](https://ccrma.stanford.edu/~jatin/chowdsp/Products/ChowTapeManual.pdf). 36 37 38 ## Plugin Development 39 40 If you'd like to contribute to the development of the plugin, 41 start by checking out the 42 [issues](https://github.com/jatinchowdhury18/AnalogTapeModel/issues) 43 page. Bug fixes and new features are always welcome. 44 45 ChowTape is built using the [JUCE](https://github.com/juce-framework/JUCE) 46 framework, and accordingly, we follow the 47 [JUCE coding standards](https://juce.com/discover/stories/coding-standards). 48 For information on getting started with development, please see the 49 [building](https://github.com/jatinchowdhury18/AnalogTapeModel/blob/master/BUILDING.md) 50 page. If you plan to implement a new feature, please create a 51 [feature request](https://github.com/jatinchowdhury18/AnalogTapeModel/issues/new?assignees=jatinchowdhury18&labels=enhancement&template=feature_request.md&title=%5BFEATURE%5D) 52 first, so the feature can be discussed by the community. 53 54 Once your development environment is set up, we recommend 55 creating a feature branch for each change you wish to make. 56 This branch should be based off of the `origin/develop` 57 branch on GitHub. When you're ready to make a pull request, 58 be sure to make `origin/develop` the target branch for your 59 pull request as well. Once your pull request has been 60 reviewed and all automated checks have passed, your changes 61 will be merged! 62 63 ## Donating 64 65 If you feel so inclined, feel free to 66 [buy me a drink](https://patreon.com/chowdsp). 67 Note that I am making this software purely out of enjoyment, 68 and I certainly do not expect any monetary compensation. Also 69 note that donating will not give you any priority in determining 70 which bugs are fixed first, or which features are implemented. 71 72 73 ## Sharing 74 75 Finally, if you enjoy using this plugin, feel free to share with 76 others! 77 78 79 --- 80 ## Contact 81 82 If you have questions, or want more information, please 83 contact me via [email](mailto:jatin@ccrma.stanford.edu).