BE-706 Switching to GitHub (#45)

* BE-706 Switching to GitHub repo * updated documents Signed-off-by: nfrunza <nfrunza@gmail.com> * BE-706 Switching to GitHub repo * updated documents Signed-off-by: nfrunza <nfrunza@gmail.com> * BE-706 Switching to GitHub repo BE-706 Switching to GitHub repo updated maintainter list * BE-706 Switching to GitHub repo updated maintainter list * BE-706 Switching to GitHub repo fixed typo Signed-off-by: nfrunza <nfrunza@gmail.com> * BE-706 Switching to GitHub removed stale file Signed-off-by: nfrunza <nfrunza@gmail.com> * BE-706 Switching to GitHub fixed type in file name DCO.md removed stale file Signed-off-by: nfrunza <nfrunza@gmail.com>
hyperledger-labs · Nov 18, 2019 · 2a28ab1 · 2a28ab1
1 parent 2ba9c95
commit 2a28ab1
Show file tree

Hide file tree

Showing 28 changed files with 242 additions and 1,063 deletions.
diff --git a/.github/stale.yml b/.github/stale.yml
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -10,27 +10,71 @@ 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
+## Documentation updates
 
-You are always welcome to contribute documentation updates and code in the form the patch submissions on [Gerrit](http://gerrit.hyperledger.org/).
+You are always welcome to contribute documentation updates and code in the form the patch submissions on [Hyperledger Explorer GitHub](https://github.com/hyperledger/blockchain-explorer).
 
 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)
 
+## Code contribution and 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).
+
+<!--  Contributing -->
+
+#To contribute changes, use the following workflow:
+
+1. [**Fork the repository**](https://github.com/hyperledger/blockchain-explorer/fork).
+1. **Clone your fork** to your computer.
+1. **Create a topic branch** and name it appropriately.
+Starting the branch name with the issue number is a good practice and a reminder to fix only one issue in a
+Pull-Request (PR)._
+1. **Make your changes** adhering to the coding conventions described below.
+_In general a commit serves a single purpose and diffs should be easily comprehensible.
+For this reason do not mix any formatting fixes or code moves with actual code changes._
+1. **Commit your changes** see [How to Write a Git Commit Message](https://chris.beams.io/posts/git-commit/) article by Chris Beams.
+1. **Test your changes** locally before pushing to ensure that what you are proposing is not breaking
+another part of the software. Running the `./main.sh clean && ./main.sh install && ./main.sh test` command locally will help you
+to be confident that your changes will pass CI tests once pushed as a Pull Request.
+1. **Push your changes** to your remote fork.
+1. **Create a pull-request** (PR) on the Hyperledger Explorer repository. If the PR addresses an existing Jira issue,
+include the issue number in the PR title in square brackets (for example, `[BE-333]`).
+1. **Add labels** to identify the type of your PR. _For example, if your PR is not ready to validate,
+add the "work-in-progress" label. If it fixes a bug, add the "bug" label._
+1. If the PR address an existing Jira issue, comment in the Jira issue with the PR number.
+1. **Ensure your changes are reviewed**.
+_Select the reviewers you would like to review your PR.
+If you don't know who to choose, simply select the reviewers proposed by GitHub or leave blank._
+1. **Make any required changes** on your contribution from the reviewers feedback.
+_Make the changes, commit to your branch, and push to your remote fork._
+1. **When your PR is validated**, all tests passed and your branch has no conflicts with the target branch,
+you can **"squash and merge"** your PR and you're done.
+
+<!--  Contributing -->
 
 ### 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).
-In the individual files, please use the following line:
+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).
+In the individual files, please use the following line, and appropriate comment by the file type.
+
+`SPDX-License-Identifier: Apache-2.0`
+
+*example for a .js file type*
+```
+/*
+* SPDX-License-Identifier: Apache-2.0
+*/
 
-SPDX-License-Identifier: Apache-2.0
+```
 
 Regarding copyright notices, we generally find that copyright notices in headers fall out of date quickly. The contributor data is stored in git and determining "copyright" requires an analysis that becomes quite complex after the initial commit.
 

diff --git a/DCO.md b/DCO.md
@@ -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).
diff --git a/MAINTAINERS.rst b/MAINTAINERS.rst
@@ -2,28 +2,31 @@
 .. SPDX-License-Identifier: Apache-2.0
 
 
-
 Maintainers
 -----------
 
-+---------------------------+---------------------+------------------+----------------+--------------------------------+
-| Name                      | Gerrit              | GitHub           | RocketChat     | email                          |
-+===========================+=====================+==================+================+================================+
-| Adam Kwan                 | adamk1230           | adamk1230        | adamk1230      | adamk1230@gmail.com            |
-+---------------------------+---------------------+------------------+----------------+--------------------------------+
-| Atsushi Neki              | nekia               | nekia            | nekia          | atsushin@fast.au.fujitsu.com   |
-+---------------------------+---------------------+------------------+----------------+--------------------------------+
-| David Huffman             | dshuffma            |                  |                | dshuffma@us.ibm.com            |
-+---------------------------+---------------------+------------------+----------------+--------------------------------+
-| Jeeva Sankarapandian      | jeevas              | jeevasang        | jeevas         | jsankarapandian@dtcc.com       |
-+---------------------------+---------------------+------------------+----------------+--------------------------------+
-| Mekia Edwards             | edwardsm26          | edwardsm26       | edwardsm26     | dev.edwardsm@gmail.com         |
-+---------------------------+---------------------+------------------+----------------+--------------------------------+
-| Nik Frunza                | nfrunza             | nickfrunza       | nfrunza        | nfrunza@gmail.com              |
-+---------------------------+---------------------+------------------+----------------+--------------------------------+
-| Satheesh Kathamuthu       | satheeshk           | xspeedcruiser    | satheeshk      | satheesh.ceg@gmail.com         |
-+---------------------------+---------------------+------------------+----------------+--------------------------------+
-| Umapathi Madiraju         | umadiraj            | umadiraju        | umadiraj       | umapathi.madiraju@gmail.com    |
-+---------------------------+---------------------+------------------+----------------+--------------------------------+
-| Vinita Chinoy             | vchinoy             | vchinoy-da       | vchinoy        | vinitachinoy@yahoo.com         |
-+---------------------------+---------------------+------------------+----------------+--------------------------------+
++---------------------------+------------------+----------------+--------------------------------+
+| Name                      |  GitHub          | RocketChat     | email                          |
++===========================+==================+================+================================+
+| Adam Kwan                 | adamk1230        | adamk1230      | adamk1230@gmail.com            |
++---------------------------+------------------+----------------+--------------------------------+
+| Atsushi Neki              |  nekia           | nekia          | atsushin@fast.au.fujitsu.com   |
++---------------------------+------------------+----------------+--------------------------------+
+| David Huffman             |                  |                | dshuffma@us.ibm.com            |
++---------------------------+------------------+----------------+--------------------------------+
+| Jeeva Sankarapandian      | jeevasang        | jeevas         | jsankarapandian@dtcc.com       |
++---------------------------+------------------+----------------+--------------------------------+
+| Mekia Edwards             | edwardsm26       | edwardsm26     | dev.edwardsm@gmail.com         |
++---------------------------+------------------+----------------+--------------------------------+
+| Nik Frunza                | nfrunza          | nfrunza        | nfrunza@gmail.com              |
++---------------------------+------------------+----------------+--------------------------------+
+| Satheesh Kathamuthu       | xspeedcruiser    | satheeshk      | satheesh.ceg@gmail.com         |
++---------------------------+------------------+----------------+--------------------------------+
+| Umapathi Madiraju         | umadiraju        | umadiraj       | umapathi.madiraju@gmail.com    |
++---------------------------+------------------+----------------+--------------------------------+
+| Vinita Chinoy             | vchinoy-da       | vchinoy        | vinitachinoy@yahoo.com         |
++---------------------------+------------------+----------------+--------------------------------+
+
+
+.. Licensed under Creative Commons Attribution 4.0 International License
+   https://creativecommons.org/licenses/by/4.0/
diff --git a/TROUBLESHOOT.md b/TROUBLESHOOT.md
@@ -385,8 +385,8 @@ Related Information:
 ```
     <<<<<<<<<<<<<<<<<<<<<<<<<< Explorer Error >>>>>>>>>>>>>>>>>>>>>
     { Error: 12 UNIMPLEMENTED: unknown service discovery.Discovery
-        at new createStatusError (/Users/USER_ID/workspace/gerrit/blockchain-explorer/node_modules/grpc/src/client.js:64:15)
-        at /Users/USER_ID/workspace/gerrit/blockchain-explorer/node_modules/grpc/src/client.js:583:15
+        at new createStatusError (/Users/USER_ID/workspace/blockchain-explorer/node_modules/grpc/src/client.js:64:15)
+        at /Users/USER_ID/workspace/blockchain-explorer/node_modules/grpc/src/client.js:583:15
       code: 12,
       metadata: Metadata { _internal_repr: {} },
       details: 'unknown service discovery.Discovery' }