Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

BE-706 Switching to GitHub repo #40

Closed
wants to merge 1 commit into from
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
13 changes: 10 additions & 3 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ We welcome contributions to the Hyperledger Explorer Project in many forms like

We track all bugs and feature requests on [Hyperledger Explorer Jira](https://jira.hyperledger.org/projects/BE/issues). 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 Chat](https://chat.hyperledger.org/channel/blockchain-explorer).
You can contact the developers for any general problems or questions on [Hyperledger Chat](https://chat.hyperledger.org/channel/hyperledger-explorer).

## Documentation updates and Code contributions

Expand All @@ -20,9 +20,16 @@ The code is structured into two main categories
* ReactJS UI (client folder)
* NodeJS back-end (all other folders)

### Gerrit

All the patches should be submitted to gerrit for review. Follow the general guidelines on getting Linux foundation account and submitting patches [here](http://hyperledger-fabric.readthedocs.io/en/latest/Gerrit/lf-account.html)
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 `GitHub <https://help.github.com/en/github/collaborating-with-issues-and-pull-requests/about-pull-requests>`__.

.. important:: Commit your changes with Jira ticket and description
..


### Copyright Notices
Expand Down
8 changes: 8 additions & 0 deletions DSO.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
DCO
===

As per section 13.a of the [Hyperledger Charter](https://www.hyperledger.org/about/charter) all code submitted to the Hyperledger Foundation needs to have a [Developer Certificate of Origin](http://developercertificate.org/) (DCO) sign-off.

The sign off needs to be using your legal name, not a pseudonym. Git has a built-in mechanism to allow this with the `-s` or `--signoff` argument to `git commit` command, providing your `user.name` and `user.email` have been setup correctly.

If you have any questions, you can reach us on [hyperledger-explorer channel](https://chat.hyperledger.org/channel/hyperledger-explorer).
57 changes: 13 additions & 44 deletions docs/source/CONTRIBUTING.rst
Original file line number Diff line number Diff line change
Expand Up @@ -11,12 +11,13 @@ Getting a Linux Foundation account
----------------------------------

In order to participate in the development of the Hyperledger Explorer
project, you will need a :doc:`Linux Foundation
account <Gerrit/lf-account>`. You will need to use your LF ID to
access to all the Hyperledger community tools, including
`Gerrit <https://gerrit.hyperledger.org>`__,
`Jira <https://jira.hyperledger.org>`__,
`RocketChat <https://chat.hyperledger.org>`__.
project, you will need a `Linux Foundation account <https://identity.linuxfoundation.org/>`__.

You will need to use your LF ID to access to all the Hyperledger community tools, including:

* `Jira <https://jira.hyperledger.org>`__.
* `RocketChat <https://chat.hyperledger.org>`__.
* `Mailing list <https://lists.hyperledger.org/g/explorer>`__.


Bug Reports and Feature Requests
Expand Down Expand Up @@ -68,9 +69,12 @@ 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 (CR).
yourself, then you can submit a change request (PR), please follow guidance provided by `GitHub <https://help.github.com/en/github/collaborating-with-issues-and-pull-requests/about-pull-requests>`__.

.. important:: Commit your changes with Jira ticket and description
..


.. note:: If you need help with submitting your first CR, we have created a brief :doc:`CR <submit_cr>`.


Working on fixing issues and working stories
Expand All @@ -87,38 +91,6 @@ saying that you are still actively working the issue if you need a
little more time.


Setting up development environment
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

Next, try :doc:`building the project <dev-setup/build>` in your local
development environment to ensure that everything is set up correctly.

Submitting your change request
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

- Changes should be small, and should cover one jira.

- Add a link to the JIRA story when submitting the change.

- Create unit and integration tests (or update to existing tests)
with every change.

- Any new or updated unit tests should have NO external dependencies.
Unit tests can be run from the project root ``blockchain-explorer`` with ``./main.sh install && ./main.sh test`` .

- Write a short and meaningful commit message, no more than 55 (or less)
character title, followed by a blank line.
Each commit MUST include the JIRA corresponding to the change (e.g. [BE-55]).

.. note:: Gerrit automatically creates a hyperlink to the JIRA item.
e.g.

::

[BE-55] Handle 500 error

Fix [BE-55] handling 500 error when server fails to return a request.

Copyright Notices

There should be a single LICENSE file in the top-level directory that contains the full text of the Apache License `here <http://www.apache.org/licenses/LICENSE-2.0>`__.
Expand Down Expand Up @@ -148,14 +120,11 @@ Related Topics
jira_navigation
dev-setup/devenv
dev-setup/build
Gerrit/lf-account
Gerrit/gerrit
Gerrit/changes
Gerrit/reviewing
Style-guides/js-style





.. Licensed under Creative Commons Attribution 4.0 International License
https://creativecommons.org/licenses/by/4.0/
161 changes: 161 additions & 0 deletions docs/source/CONTRIBUTING_OLD.xxrst
Original file line number Diff line number Diff line change
@@ -0,0 +1,161 @@

.. SPDX-License-Identifier: Apache-2.0


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 :doc:`Linux Foundation
account <Gerrit/lf-account>`. You will need to use your LF ID to
access to all the Hyperledger community tools, including
`Gerrit <https://gerrit.hyperledger.org>`__,
`Jira <https://jira.hyperledger.org>`__,
`RocketChat <https://chat.hyperledger.org>`__.


Bug Reports and Feature Requests
--------------------------------

We track all bugs and feature requests on `Hyperledger Explorer Jira <https://jira.hyperledger.org/projects/BE/issues>`__.
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 <https://chat.hyperledger.org/channel/hyperledger-explorer>`__.


Communications
--------------

We use `RocketChat <https://chat.hyperledger.org/channel/hyperledger-explorer>`__ for communication
and Zoom meeting™ for screen sharing between developers. Our
development planning and prioritization is done in
`JIRA <https://jira.hyperledger.org/secure/RapidBoard.jspa?rapidView=155&view=planning>`__, and we take longer running
discussions/decisions to the `mailing
list <https://lists.hyperledger.org/g/explorer>`__.

Contribution guide
------------------

Prerequisites
~~~~~~~~~~~~~~~~~~~~~

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) <https://stedolan.github.io/jq>`__
- Linux-based operating system, such as Ubuntu
- MacOS

Verified Docker versions supported:

- `Docker CE 18.09.2 or later <https://hub.docker.com/search/?type=edition&offering=community&operating_system=linux>`__
- `Docker Compose 1.14.0 <https://docs.docker.com/compose>`__




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 (CR).

.. note:: If you need help with submitting your first CR, we have created a brief :doc:`CR <submit_cr>`.


Working on fixing issues and working stories
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

Review the `issues
list <https://jira.hyperledger.org/secure/RapidBoard.jspa?rapidView=155&view=planning.nodetail>`__ 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.


Setting up development environment
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

Next, try :doc:`building the project <dev-setup/build>` in your local
development environment to ensure that everything is set up correctly.

Submitting your change request
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

- Changes should be small, and should cover one jira.

- Add a link to the JIRA story when submitting the change.

- Create unit and integration tests (or update to existing tests)
with every change.

- Any new or updated unit tests should have NO external dependencies.
Unit tests can be run from the project root ``blockchain-explorer`` with ``./main.sh install && ./main.sh test`` .

- Write a short and meaningful commit message, no more than 55 (or less)
character title, followed by a blank line.
Each commit MUST include the JIRA corresponding to the change (e.g. [BE-55]).

.. note:: Gerrit automatically creates a hyperlink to the JIRA item.
e.g.

::

[BE-55] Handle 500 error

Fix [BE-55] handling 500 error when server fails to return a request.

Copyright Notices

There should be a single LICENSE file in the top-level directory that contains the full text of the Apache License `here <http://www.apache.org/licenses/LICENSE-2.0>`__.





.. note:: In the individual files, please use the following line:


::

/*
SPDX-License-Identifier: Apache-2.0
*/



Related Topics
--------------

.. toctree::
:maxdepth: 1

MAINTAINERS
jira_navigation
dev-setup/devenv
dev-setup/build
Gerrit/lf-account
Gerrit/gerrit
Gerrit/changes
Gerrit/reviewing
Style-guides/js-style




.. Licensed under Creative Commons Attribution 4.0 International License
https://creativecommons.org/licenses/by/4.0/
100 changes: 0 additions & 100 deletions docs/source/Gerrit/changes.rst

This file was deleted.

Loading