Skip to content

Latest commit

 

History

History
65 lines (46 loc) · 2.21 KB

CONTRIBUTING.md

File metadata and controls

65 lines (46 loc) · 2.21 KB
Raw

On Contributing

To contribute to the Starcoin implementation, first start with the proper development copy.

To get the development installation with all the necessary dependencies for linting, testing, and building the documentation, run the following:

git clone https://github.com/starcoinorg/starcoin.git
cd starcoin
./scripts/dev_setup.sh
source $HOME/.cargo/env
cargo build

Our Development Process

Code Style, Hints, and Testing

All code formatting is enforced with rustfmt with a project-specific configuration and checked by GitHub action.

Rust code should follow the rust coding guidelines:

Developer Workflow

Changes to the project are proposed through pull requests. The general pull request workflow is as follows:

  1. Fork the repo and create a topic branch off of master.
  2. If you have added code that should be tested, add unit tests.
  3. Fast check commit by ./scripts/check_commit.sh.
  4. Make sure your local workspace is clean and all changed file has been committed.
  5. Submit your pull request.
  6. Waiting for the github action check to pass and responding to reviewer feedback.

Starcoin Move framework contribution document at Starcoin Move Framework.

How to update the pull request

If your pull request is out-of-date and needs to be updated because master has advanced, you should rebase your branch on top of the latest main by doing the following:

git fetch upstream
git checkout topic
git rebase -i upstream/master

You should not update your branch by merging the latest main into your branch. Merge commits included in PRs tend to make it more difficult for the reviewer to understand the change being made, especially if the merge wasn't clean and needed conflicts to be resolved. As such, PRs with merge commits will be rejected.

Issues

Starcoin uses GitHub issues to track bugs. Please include necessary information and instructions to reproduce your issue.