Skip to content

Latest commit

 

History

History
46 lines (33 loc) · 1.67 KB

CONTRIBUTING.md

File metadata and controls

46 lines (33 loc) · 1.67 KB
Raw

Contributing guidelines

How to contribute

This project accepts contributions from anyone interested in improving it. To do so, follow these steps:

  1. Fork it
  2. Improve it, respecting the coding standards and using proper commit messages
  3. Submit a pull request

Your work will then be reviewed as soon as possible (suggestions about some changes, improvements or alternatives may be given).

Do not forget to verify that all tests pass, adding new ones if necessary. Also, do not forget to update the documentation if relevant.

Coding standards

  • Code must work in MATLAB (>= 2013a) and Octave (>= 4.0.0)
  • MATLAB-style documentation and comments
  • Indentation: four spaces, no tabs
  • Encoding: UTF-8
  • Line size limit: 80 chars
  • Newlines: Unix style, i.e. LF or \n
  • Function names: lower_case_with_underscores_allowed_butnotrequired

Issues and support

Problems with this software can be reported in the issues section. Support for micompm is provided on best effort basis by emailing the author at nfachada@laseeb.org.

Note

This document is partially adapted from the TempoSimple contributing guidelines.