33We welcome contributions to the Hyperledger Project in many forms, and
44there's always plenty to do!
55
6- First things first, please review the Hyperledger Project's [ Code of
7- Conduct] ( https://github.com/hyperledger/hyperledger/wiki/Hyperledger-Project-Code-of-Conduct )
6+ First things first, please review the Hyperledger Project's [ Code of Conduct] ( https://wiki.hyperledger.org/community/hyperledger-project-code-of-conduct )
87before participating. It is important that we keep things civil.
98
109## Getting a Linux Foundation account
1110
1211In order to participate in the development of the Hyperledger Fabric project,
13- you will need an [ LF account] ( Gerrit/lf-account.md ) . You will need to use
14- your LF ID to grant you access to all the Hyperledger community tools, including
15- [ Gerrit] ( https://gerrit.hyperledger.org ) and [ Jira] ( https://jira.hyperledger.org ) .
12+ you will need a [ Linux Foundation account] ( Gerrit/lf-account.md ) . You will need
13+ to use your LF ID to access to all the Hyperledger community development tools,
14+ including [ Gerrit] ( https://gerrit.hyperledger.org ) ,
15+ [ Jira] ( https://jira.hyperledger.org ) and the
16+ [ Wiki] ( https://wiki.hyperledger.org/start ) (for editing, only).
1617
1718### Setting up your SSH key
1819
19- For Gerrit, you will want to register your public SSH key. Login to
20- [ Gerrit] ( https://gerrit.hyperledger.org )
21- with your LF account, and click on your name in the upper right-hand corner
22- and then click 'Settings'. In the left-hand margin, you should see a link for
23- 'SSH Public Keys'. Copy-n-paste your [ public SSH key] ( https://help.github.com/articles/generating-an-ssh-key/ )
20+ For Gerrit, before you can submit any change set for review, you will need to
21+ register your public SSH key. Login to [ Gerrit] ( https://gerrit.hyperledger.org )
22+ with your [ LFID] ( Gerrit/lf-account.md ) , and click on your name in the upper
23+ right-hand corner of your browser window and then click 'Settings'. In the
24+ left-hand margin, you should see a link for 'SSH Public Keys'. Copy-n-paste
25+ your [ public SSH key] ( https://help.github.com/articles/generating-an-ssh-key/ )
2426into the window and press 'Add'.
2527
2628## Getting help
@@ -30,55 +32,57 @@ debugging a problem or working out a fix to an issue, our
3032[ community] ( https://www.hyperledger.org/community ) is always eager to help. We
3133hang out on [ Slack] ( https://hyperledgerproject.slack.com/ ) , IRC (#hyperledger on
3234freenode.net) and the [ mailing lists] ( http://lists.hyperledger.org/ ) . Most of us
33- don't bite ;-) and will be glad to help.
35+ don't bite :grin : and will be glad to help. The only silly question is the one
36+ you don't ask. Questions are in fact a great way to help improve the project as
37+ they highlight where our documentation could be clearer.
3438
3539## Requirements and Use Cases
3640
3741We have a [ Requirements
38- WG] ( https://github.com/ hyperledger/hyperledger/wiki/Requirements-WG ) that is
42+ WG] ( https://wiki. hyperledger.org/groups/requirements/requirements-wg ) that is
3943documenting use cases and from those use cases deriving requirements. If you are
4044interested in contributing to this effort, please feel free to join the
4145discussion in
4246[ slack] ( https://hyperledgerproject.slack.com/messages/requirements/ ) .
4347
4448## Reporting bugs
4549
46- If you are a user and you find a bug, please submit an
47- [ issue ] ( https://github.com/ hyperledger/fabric/issues ) . Please try to provide
50+ If you are a user and you find a bug, please submit an issue using
51+ [ JIRA ] ( https://jira. hyperledger.org ) . Please try to provide
4852sufficient information for someone else to reproduce the issue. One of the
4953project's maintainers should respond to your issue within 24 hours. If not,
50- please bump the issue and request that it be reviewed.
54+ please bump the issue with a comment and request that it be reviewed. You can
55+ also post to the ` #fabric-maintainers ` channel in
56+ [ slack] ( https://hyperledgerproject.slack.com/messages/requirements/ ) .
5157
5258## Fixing issues and working stories
59+
5360Review the [ issues list] ( https://github.com/hyperledger/fabric/issues ) and find
54- something that interests you. You could also check the [ "help
55- wanted"] ( https://github.com/hyperledger/fabric/issues?q=is%3Aissue+is%3Aopen+label%3A%22help+wanted%22 )
56- and [ "good first
57- bug"] ( https://github.com/hyperledger/fabric/issues?q=is%3Aissue+is%3Aopen+label%3Agood-first-bug )
58- lists. It is wise to start with something relatively straight forward and
59- achievable. Usually there will be a comment in the issue that indicates whether
60- someone has already self-assigned the issue. If no one has already taken it,
61- then add a comment assigning the issue to yourself, eg.: `I'll work on this
62- issue.`. Please be considerate and rescind the offer in comments if you cannot
63- finish in a reasonable time, or add a comment saying that you are still actively
64- working the issue if you need a little more time.
61+ something that interests you. You could also check the
62+ [ "help-wanted"] ( https://jira.hyperledger.org/issues/?jql=project%20%3D%20Fabric%20AND%20labels%20%3D%20help-wanted )
63+ list. It is wise to start with something relatively straight forward and
64+ achievable, and that no one is already assigned. If no one is assigned,
65+ then assign the issue to yourself. Please be considerate and rescind the
66+ assignment if you cannot finish in a reasonable time, or add a comment
67+ saying that you are still actively working the issue if you need a little
68+ more time.
6569
6670## Working with a local clone and Gerrit
6771
6872We are using [ Gerrit] ( https://gerrit.hyperledger.org/r/#/admin/projects/fabric )
69- to manage code contributions. If you are unfamiliar, please review [ this
70- document] ( Gerrit/gerrit.md ) before proceeding.
73+ to manage code contributions. If you are unfamiliar, please review this
74+ [ document] ( Gerrit/gerrit.md ) before proceeding.
7175
7276After you have familiarized yourself with ` Gerrit ` , and maybe played around with
73- the ` lf-sandbox ` project, you should be ready to set up your local [ development
74- environment] ( dev-setup/devenv.md ) . We use a Vagrant-based approach to
75- development that simplifies things greatly.
77+ the ` lf-sandbox `
78+ [ project] ( https://gerrit.hyperledger.org/r/#/admin/projects/lf-sandbox,branches ) ,
79+ you should be ready to set up your local development
80+ [ environment] ( dev-setup/devenv.md ) .
7681
7782## Coding guidelines
7883
79- Be sure to check out the language-specific [ style
80- guides] ( Style-guides/go-style.md ) before making any changes. This will ensure a
81- smoother review.
84+ Be sure to check out the language-specific [ style guides] ( Style-guides/go-style.md )
85+ before making any changes. This will ensure a smoother review.
8286
8387### Becoming a maintainer
8488
0 commit comments