Skip to content

Latest commit

 

History

History
13 lines (11 loc) · 620 Bytes

CONTRIBUTING.md

File metadata and controls

13 lines (11 loc) · 620 Bytes

How to contribute to project

There are mainly two sections, code and documentation.

For contributing to codes:

  • Please use existing objects like Force, Matrix, Displacement etc. while not creating new data objects as much as possible.
  • Please document methods and properties
  • Please note that being compact and simple to use is appreciated in code.
  • Please create a code that be simple to maintain also simple to understand, at least in class design level.

For contributing to documentation:

  • Please use images for illustrating phisical stuff
  • Please note the units of values you use in examples