Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
77 lines (50 loc) · 2.59 KB

CONTRIBUTING.md

File metadata and controls

77 lines (50 loc) · 2.59 KB

Introduction

The project employs GitHub as the code commit/review system.

In brief, if you want to contribute, create or find some GitHub Issues and submit changes via GitHub Pull Requests.

Questions and discussions

  • Wikipage: Lots of information and documentation about the project, e.g., meeting schedule, design doc.
  • Mail List: General technical topics with Cello project.

Code Commit Steps

  1. Fork the repository

Click the "Fork" button at the top right of the repository page.

  1. Clone the project to your working directory.
$ git clone https://github.com/<your-username>/cello.git
$ cd cello
  1. Config your git name and email if not setup previously.
$ git config user.name "your name"
$ git config user.email "your email"
  1. Create a feature branch

Always create a meaningful branch name off main:

$ git checkout -b feature/awesome-feature
  1. After modifying the code, run make check to make sure all the checking is passed.
$ make check
  ...
  py27: commands succeeded
  py30: commands succeeded
  py35: commands succeeded
  flake8: commands succeeded
  congratulations :)
  1. Commit your code with -s to sign-off, and -a to automatically add changes (or run git add . to include all changes manually).
$ git commit -s -a

Example commit msg may look like:

A short description of your change with no period at the end

You can add more details here in several paragraphs, but please keep each line
width less than 80 characters. A bug fix should include the issue number.

Signed-off-by: Your Name <committer@email.address>
  1. Open a PR on https://github.com/hyperledger-cello/cello/pulls.

After the ci checking passed, wait for reviewers to approve it. The patch will be merged into the main branch after passing the review.

If you need to refine the patch further as the reviewers may suggest, you can change on the same branch, and commit the new code, and then re-request review.

Creative Commons License
This work is licensed under a Creative Commons Attribution 4.0 International License.