Skip to content

Latest commit

 

History

History
30 lines (17 loc) · 1.88 KB

CONTRIBUTING.md

File metadata and controls

30 lines (17 loc) · 1.88 KB
Raw

Contributing

To start, we thank you for considering contributing to this project. Contributions are welcome, are greatly appreciated, and will be appropriately acknowledged.

When contributing to this repository, we ask that you discuss the change you wish to make via issue or email with the owners of this repository before making a change. In return, developers should respond by addressing your issue, assessing changes, and helping you finalize your pull requests.

Types of contributions

You can contribute to this project in two significant ways:

  1. Reporting and fixing bugs. We encourage users open an issue on GitHub, choosing from the corresponding template.

  2. Suggesting or implementing features and enhancements. If you find yourself wishing for a feature that doesn't currently exist in this codebase, you may not be alone. We encourage users to suggest enhancements or missing features to the developers. As with above, we encourage users open an issue on GitHub, choosing from the corresponding template. Please do not combine multiple feature requests into a single issue, if at all possible.

Contributions will be under the MIT License

In short, when you submit code changes, your submissions are understood to be under the same MIT License that covers the project. Feel free to contact the maintainers if that's a concern.

Using a consistent coding style

A couple of notes to keep things consistent:

  • Variable and function names are generally all lowercase, separated by underscores where relevant.
  • For Matlab structures, the first letter of the variable name is capitalized (e.g., Aggs and Imgs).
  • Variables composed of images are normally given names of the form imgs_*.
  • Indenting is given by a tab.

Coding standards

English language