sampsapursiainen / zeffiro_interface

Interface for using finite elements in inverse problems with complex domains
GNU General Public License v3.0
25 stars 15 forks source link

Add CONTRIBUTING instructions #136

Closed SeSodesa closed 2 years ago

SeSodesa commented 2 years ago

The file CONTRIBUTING.md should be created in the repository root, explaining to possible project participants the practices that the project uses. These include

  1. creating new branches when working on new features or fixes,
  2. squashing a (copy of a) branch into a single commit, if the branch contains multiple commits during a pull request,
  3. using proper indentation in code files submitted,
  4. removing unnecessary trailing whitespace from code files before submitting and
  5. using Matlab function argument validation in functions whenever possible,

at the very least.

SeSodesa commented 2 years ago

Closed by #155.