Skip to content

Latest commit

 

History

History
43 lines (29 loc) · 1.96 KB

ContributingGuidelines.md

File metadata and controls

43 lines (29 loc) · 1.96 KB

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).

Coding standards

  • Code must work in MATLAB (>= 2017a).
  • MATLAB-style documentation and comments.
  • Encoding: UTF-8.
  • Newlines: Unix style, i.e. LF or sprintf('\n').

Issues and support

Problems with this software can be reported in the issues section. Support for stedy is provided on best effort basis by emailing the author at [email protected].

Test Case

2 test cases (TestPendulum.m and TestTBar.m) has been provided in the Tests folder of the repository for the user to test their version of the code. On running the files, the results of the three checks - Bar Length violations, total energy violations, and motion errors - will be displayed on the command window.

Please note that the main contributions of the software comprise an efficient Lagrangian formulation of the dynamics and a novel constraint correction method. Improvements to plotting functions are not the focus of these test cases.

Note

This document is partially adapted from the TempoSimple contributing guidelines.