Skip to content

Latest commit

 

History

History
19 lines (11 loc) · 1.65 KB

CONTRIBUTING.md

File metadata and controls

19 lines (11 loc) · 1.65 KB

Contributing to Cartesi

Thank you for your interest in Cartesi! We highly appreciate even the smallest of fixes or additions to our project.

Make sure to review our Contributing License Agreement, sign and send it to [email protected] with the title of "CLA Signed" before taking part in the project. We are happy to automate this for you via DocuSign upon request in the Google Form as well.

Basic Contributing Guidelines

We use the same guidelines for contributing code to any of our repositories, any developers wanting to contribute to Cartesi must create pull requests. This process is described in the GitHub documentation. Each pull request should be started against the master branch in the respective Cartesi repository. After a pull request is submitted the Cartesi team will review the submission and give feedback via the comments section of the pull request. After the submission is reviewed and approved, it will be merged into the master branch of the source.

Please note the below! We appreciate everyone following the guidelines.

  • No --force pushes or modifying the Git history in any way;
  • Use non-master branches, using a short meaningful description, with words separated by dash (e.g. 'fix-this-bug');
  • All modifications must be made in a pull-request to solicit feedback from other contributors.

Get in Touch

When contributing in a deeper manner to this repository, please first discuss the change you wish to make via our Discord channel here, or contact us at [email protected] email before working on the change.