First off, thanks for your interest in contributing to Aimt! I appreciate the contributions of all types. See the table of contents for different ways to help and details about this project. These are mostly guidelines, not rules. So, use your best judgment, and feel free to propose changes, including in this document.
What should I know before I get started?
The Aimt is an array index mapping tool. This is an open-source project that contains two main functions ind2sub and sub2ind, which interconvert between index and subscripts. This simple tool was designed to be incorporated into C codes, and therefore is compatible with C++ as well.
If you run into an error or bug with the project:
- Open an issue at https://github.com/lobophf/aimt/issues
- Include reproduction steps that someone else can follow to recreate the bug or error on their own.
- Provide details like operating system and compiler versions.
So you wanna contribute! Awesome! This project uses GitHub to manage contributions, so you can fork this repository, make your changes, push your changes in a side branch, and finally create a pull request.
To write commits messages, it would be nice if you used the template available in this repository. You can easily configure it using the command below:
$ git config --local commit.template docs/.git-commit-template.txt
So, when you create a commit, don't use the "-m" or "--message" option. Just type the command below and wait for your editor to open. The template file contains other instructions. When you finished, save and close the file.
$ git commit