Skip to content

Latest commit

 

History

History
30 lines (23 loc) · 1.12 KB

CONTRIBUTING.md

File metadata and controls

30 lines (23 loc) · 1.12 KB
Raw

Contributing

Since MTEX is open source we are happy about any kind of contribution. In order to suggest bug fixes, new features or improved documentation you have two options:

The simple way for small changes

  1. open the MTEX Github repository https://github.com/mtex-toolbox/mtex in you browser
  2. click on the file you want to edit or click Add File
  3. make your changes to the file or upload you file
  4. click Propose changes or Propose new file
  5. click Create pull request
  6. explain your contribution in the text field
  7. click Create pull request
  8. wait for you changes to be merged into MTEX development branch

The consistent way for bigger changes

  1. fork the MTEX repository to your personal GitHub account
  2. clone it on your local computer
  3. apply your changes
  4. push your changes to your personal GitHub account
  5. create a pull request to MTEX/development
  6. wait for you changes to be merged into MTEX development branch

Note, that when cloning MTEX the binaries in mtex/mex and mtex/extern/nfft are not included but must be copied from an zip-file based installation as explained above.