CONTRIBUTING.md 1.93 KB
Newer Older
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31
#### Contributing to the ITA-Toolbox

You can contribute to the ITA-Toolbox in many ways:

* reporting bugs,
* fixing bugs,
* writing documentation,
* implementing new features,
* improving existing features. 

## Reporting Bugs

* Please make sure that the [software requirements](https://git.rwth-aachen.de/ita/toolbox/blob/master/Getting_Started.txt) for using the ITA-Toolbox are fulfilled.
* You can report bugs using the [issue tracker on the projects GitLab page](https://git.rwth-aachen.de/ita/toolbox/issues) or by sending an E-Mail to the [developer mailing list](mailto:toolbox-dev@akustik.rwth-aachen.de). Make sure that your bug report is structured and includes all necessary detail for us to fix it. For guidelines on how to write a bug report take a look at [Good Bug Reports](http://martiancraft.com/blog/2014/07/good-bug-reports/). In short:
	* Mention your MATLAB version, the operating system and its version.
	* Choose a matching title that is descriptive for your bug.
	* Give a SHORT MATLAB code snippet or figure that shows the issue.
	* Give a detailed description of the problem at hand.


## Submitting Bugfixes and Features

For style guidelines and best practices in writing code for the ITA-Toolbox please take a look at the corresponding [Wiki section](https://git.rwth-aachen.de/ita/toolbox/wikis/home).

You can contribute bugfixes and features by submitting [merge requests](https://git.rwth-aachen.de/ita/toolbox/merge_requests) to the repository.
Make sure that you follow the following guidelines:
* It is highly recommended that you generate a new branch when working on a bugfix or a new feature.
* Work on your fix/feature inside your new branch.
* Create representative tests for your code if you create a new feature.
* Once finished file the merge request. Your merge request will now be reviewed and discussed.
* After all discussions are resolved and your request gets approved your code will be merged into the master branch.