Skip to content

Latest commit

 

History

History
122 lines (76 loc) · 6.33 KB

CONTRIBUTING.md

File metadata and controls

122 lines (76 loc) · 6.33 KB
Raw

Contribution

Any kind of contribution is encouraged, e.g., bug report, question answer, and submit pull-request.

Before taking actions, we highly recommend reading the documentation in docs.

LF ID Application

All the tools require an Linux Foundation (LF) ID and Github ID.

If you do not have an LF ID, can apply one for free.

GitHub Issues

We are using GitHub Issues for issue management and you are welcome to report bug issues there.

Labels on GitHub help you organize and prioritize your work. You can apply labels to issues to signify priority, category, or any other information you find useful.

The list of lables can be found here.

In brief, if you want to contribute, create or find some an open issue, and assign it to yourself.

Jira board usage

We are using Jira to track the project progress, and welcome to report bug issues or create to-do tasks there. Each item should try keeping simple and focused, hence easy to fix and review.

After login with your LF ID, you can see those task items may have 4 status:

  • To Do: Available for picking.
  • In Progress: Picked by someone (check the assignee) to work on.
  • In Review: Related patchset has been submitted for review.
  • Done: Patchset merged, the item is done.

In brief, if you want to contribute, create or find some To Do item, and assign it to yourself, then update its status to In Progress. After the item is fixed, remember to mark it as In Review and Done when the patch is submitted and merged.

Questions and discussions

  • RocketChat: technical discussions and questions, login with your LF ID.

Coding Style

We're following pep8 style guide and Google style, please see coding style

Code Commit Steps

The project employs Github as the code commit/review system, and use hub tool.

*Before committing code, please go to Jira to create a new task or check if there's related existing one, then assign yourself as the assignee. Notice each task will get a Jira number like FABP-3082.

  • Clone this project fabric-sdk-py into your working directory.
$ git clone https://github.com/hyperledger/fabric-sdk-py.git
$ cd fabric-sdk-py
$ hub fork --remote-name=origin
$ git branch main --set-upstream-to origin/main

(Optionally) Config your git name and email if not setup previously.

$ git config user.name "your name"
$ git config user.email "your email"
  • Assign yourself a To Do Jira task, mark it as In progress, then create a branch with the Jira task number off of your cloned repository, e.g., for FABP-XXXX, it can be:
$ cd fabric-sdk-py
$ git fetch upstream main && git rebase FETCH_HEAD && git push -f origin
$ git checkout -b FABP-XXXX
  • After modifying the code, run make check to make sure all the checking is passed. Then Commit your code with -s to sign-off, and -a to automatically add changes (or run git add . to include all changes manually).
$ make check
  ...
  py37: commands succeeded
  flake8: commands succeeded
  congratulations :)

$ git commit -s -a

Example commit msg may look like:

[FABP-164] 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.

Change-Id: Ife0f1a3866a636991e36b0b5b25b8f58c9208b79
Signed-off-by: Your Name <committer@email.address>
  • Push the code to the origin repo and create a pull request.
$ hub push --set-upstream origin FABP-xxxx
$ hub pull-request

Notice you will get a GitHub URL, open and check the status.

After the ci checking passed, add reviewers to the reviewer list and also post the GitHub PR url in the chat channel. The patch will be merged into the main branch after passing the review, then mark the Jira item as Done.

  • 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 with git commit -a --amend, and then use the git review command again.

Maintainers

The project’s Maintainers are responsible for reviewing and merging all patches submitted for review and they guide the over-all technical direction of the project within the guidelines established by the Hyperledger Technical Steering Committee (TSC).

Becoming a maintainer

The project’s maintainers will, from time-to-time, consider adding or removing a maintainer. An existing maintainer can submit a change set to the Maintainers file. A nominated Contributor may become a Maintainer by a majority approval of the proposal by the existing Maintainers. Once approved, the change set is then merged and the individual is added to (or alternatively, removed from) the maintainers group. Maintainers may be removed by explicit resignation, for prolonged inactivity (3 or more months), or for some infraction of the code of conduct or by consistently demonstrating poor judgement. A maintainer removed for inactivity should be restored following a sustained resumption of contributions and reviews (a month or more) demonstrating a renewed commitment to the project.

License

Hyperledger Fabric-SDK-Py software uses the Apache License Version 2.0 software license.

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