Contributing to Hyperledger Explorer¶
We welcome contributions to the Hyperledger Explorer Project in many forms like bug reports, feature requests, documentation updates, code.
Getting a Linux Foundation account¶
In order to participate in the development of the Hyperledger Explorer project, you will need a Linux Foundation account.
You will need to use your LF ID to access to all the Hyperledger community tools, including:
Bug Reports and Feature Requests¶
We track all bugs and feature requests on Hyperledger Explorer Jira. Please send a detailed bug report with relevant logs and steps to reproduce the issue when you encounter an issue. We always appreciate such bug reports as it reduces our effort and will help us fix the bug easily. Please use the search functionality to ensure that the bug/feature request you are trying to file does not exist already. If it exists, you can always add additional information to the JIRA issue in the comments sections and start watching for updates. All the issue here will be added to our backlog and prioritized in the upcoming sprints. You can contact the developers for any general problems or questions on Hyperledger Explorer Chat.
We use RocketChat for communication and Zoom meeting™ for screen sharing between developers. Our development planning and prioritization is done in JIRA, and we take longer running discussions/decisions to the mailing list.
Following are the software dependencies required to install and run Hyperledger Explorer:
- Nodejs 8.11.x (Note that v9.x is not yet supported)
- PostgreSQL 9.5 or greater
- jq (command-line JSON processor)
- Linux-based operating system, such as Ubuntu
Verified Docker versions supported:
Working on fixing issues and working stories¶
Review the issues list and find something that interests you. Start with something relatively straight forward and achievable, and that no one is already assigned. If no one is assigned, then assign the issue to yourself. Please be considerate and rescind the assignment if you cannot finish in a reasonable time, or add a comment saying that you are still actively working the issue if you need a little more time.
Submitting your fix¶
If you just submitted a JIRA for a bug you’ve discovered, and would like to provide a fix, we would welcome that gladly! Please assign the JIRA issue to yourself, then you can submit a change request (PR), please follow guidance provided by CONTRIBUTING.md.