Skip to content

Latest commit

 

History

History
61 lines (42 loc) · 2.11 KB

CONTRIBUTING.md

File metadata and controls

61 lines (42 loc) · 2.11 KB
Raw

Contributing

This file describes the process for contributing to seda-chain.

Starting

First and foremost, fork the repository. Then please read the developing instructions for setting up your environment.

Commits

Your commits must follow specific guidelines.

Signed Commits

Sign all commits with a GPG key. GitHub has extensive documentation on how to:

  • Create a new GPG key.
  • Add a GPG key to your GitHub.
  • Sign your commits.

Convention

All commits are to follow the Conventional Commits standard. Commit messages should always be meaningful.

Getting Ready For a PR

This section describes actions to keep in mind while developing.

Change Size

Please try to keep changes small to make reviews easier. We will reject more extensive unless there is a valid reason.

Formatting and Cleanliness

Please ensure your code is formatted and clippy gives no warnings.

PRs

For creating the PR, please follow the instructions below.

  1. Firstly, please open a PR from your forked repo to the main branch of seda-chain.
  2. Please fill in the PR template that is there.
  3. Then assign it to yourself and anyone else who worked on the issue with you.
  4. Make sure all CI tests pass.
  5. Finally, please assign at least two reviewers to your PR: