Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
25 lines (13 loc) · 1.38 KB

CONTRIBUTING.md

File metadata and controls

25 lines (13 loc) · 1.38 KB
Raw

Contributing to CADAM

When contributing to this repository, please first discuss the change you wish to make via issues before making a change.

Please note we have a code of conduct, please follow it in all your interactions with the project.

Pull Request Process

  1. Fork the project - Create a fork of the repository to your own GitHub account.

    Fork

  2. Create your changes - Make your changes in your fork and open a PR from that fork.

  3. Update the PR description - Include details of the changes. Link the issue if relevant.

  4. Allow maintainer edits - Be sure to check the box to "Allow edits from maintainer". This allows maintainers to update your PR if necessary which speeds up the review process. Learn more here.

  5. Request a review - Request a review from one of the maintainers. Once accepted, they will be able to merge your PR.

Style Guide

We try to follow guidelines from Clean Code and the Boy Scout Rule:

"Leave the code cleaner, not messier, than how you found it."