From 54312ea7ea2c07ff54338a04c7a0cb82517f8da3 Mon Sep 17 00:00:00 2001 From: Alexader Date: Mon, 30 Mar 2020 19:45:33 +0800 Subject: [PATCH] chore(*): add license files --- .github/ISSUE_TEMPLATE/bug-report.md | 19 +++ .github/ISSUE_TEMPLATE/enhancement.md | 7 + .github/ISSUE_TEMPLATE/feature.md | 19 +++ .github/ISSUE_TEMPLATE/question.md | 7 + CONTRIBUTING.md | 141 ++++++++++++++++++ LICENSE | 201 ++++++++++++++++++++++++++ 6 files changed, 394 insertions(+) create mode 100644 .github/ISSUE_TEMPLATE/bug-report.md create mode 100644 .github/ISSUE_TEMPLATE/enhancement.md create mode 100644 .github/ISSUE_TEMPLATE/feature.md create mode 100644 .github/ISSUE_TEMPLATE/question.md create mode 100644 CONTRIBUTING.md create mode 100644 LICENSE diff --git a/.github/ISSUE_TEMPLATE/bug-report.md b/.github/ISSUE_TEMPLATE/bug-report.md new file mode 100644 index 00000000..24493e2e --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug-report.md @@ -0,0 +1,19 @@ +--- +name: 'Bug Report' +about: 'As a User, I want to report a Bug.' +labels: bug +--- + +## Bug Report + +Please answer these questions before submitting your issue. Thanks! + +### 1. What did you do? + + + +### 2. What did you expect to see? + +### 3. What did you see instead? + +### 4. What version of BitXHub are you using? (`bitxhub version` on BitXHub) diff --git a/.github/ISSUE_TEMPLATE/enhancement.md b/.github/ISSUE_TEMPLATE/enhancement.md new file mode 100644 index 00000000..ebca8f04 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/enhancement.md @@ -0,0 +1,7 @@ +--- +name: 'Development Task' +about: 'As a BitXHub developer, I want to record a development task.' +labels: enhancement +--- + +## Development Task diff --git a/.github/ISSUE_TEMPLATE/feature.md b/.github/ISSUE_TEMPLATE/feature.md new file mode 100644 index 00000000..ddcc3ae6 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/feature.md @@ -0,0 +1,19 @@ +--- +name: 'Feature Request' +about: 'As a user, I want to request a New Feature on the product.' +labels: feature +--- + +## Feature Request + +**Is your feature request related to a problem? Please describe:** + + +**Describe the feature you'd like:** + + +**Describe alternatives you've considered:** + + +**Teachability, Documentation, Adoption, Migration Strategy:** + diff --git a/.github/ISSUE_TEMPLATE/question.md b/.github/ISSUE_TEMPLATE/question.md new file mode 100644 index 00000000..956a639c --- /dev/null +++ b/.github/ISSUE_TEMPLATE/question.md @@ -0,0 +1,7 @@ +--- +name: 'Ask a Question' +about: 'I want to ask a question.' +labels: question +--- + +## General Question diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 00000000..aefda064 --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,141 @@ +# Contributing + +## Submission Guidelines + +### Submitting a Pull Request (PR) +Before you submit your Pull Request (PR) consider the following guidelines: + +1. Search [GitHub](https://github.com/meshplus/bitxhub/pulls) for an open or closed PR + that relates to your submission. You don't want to duplicate effort. +1. Be sure that an issue describes the problem you're fixing, or documents the design for the feature you'd like to add. + Discussing the design up front helps to ensure that we're ready to accept your work. +1. Fork the meshplus/bitxhub repo. +1. Make your changes in a new git branch: + + ```shell + git checkout -b my-fix-branch master + ``` + +1. Create your patch, **including appropriate test cases**. +1. Follow gofmt and golint specifications. +1. Run the full test suite and ensure that all tests pass. +1. Commit your changes using a descriptive commit message that follows our + [commit message conventions](#commit). Adherence to these conventions + is necessary because release notes are automatically generated from these messages. + + ```shell + git commit -a + ``` + + Note: the optional commit `-a` command line option will automatically "add" and "rm" edited files. + +1. Push your branch to GitHub: + + ```shell + git push origin my-fix-branch + ``` + +1. In GitHub, send a pull request to `bitxhub:master`. + +* If we suggest changes then: + * Make the required updates. + * Re-run the test suites to ensure tests are still passing. + * Rebase your branch and force push to your GitHub repository (this will update your Pull Request): + + ```shell + git rebase master -i + git push -f + ``` + +That's it! Thank you for your contribution! + +#### After your pull request is merged + +After your pull request is merged, you can safely delete your branch and pull the changes +from the main (upstream) repository: + +* Delete the remote branch on GitHub either through the GitHub web UI or your local shell as follows: + + ```shell + git push origin --delete my-fix-branch + ``` + +* Check out the master branch: + + ```shell + git checkout master -f + ``` + +* Delete the local branch: + + ```shell + git branch -D my-fix-branch + ``` + +* Update your master with the latest upstream version: + + ```shell + git pull --ff upstream master + ``` + +## Commit Message Guidelines + +Commit Message in this repository should strictly follow the [AngularJS Git Commit Message Conventions](https://github.com/angular/angular/blob/master/CONTRIBUTING.md#-commit-message-guidelines). We explain the conventions below. For detail explanation, it can be found in this [document](https://docs.google.com/document/d/1QrDFcIiPjSLDn3EL15IJygNPiHORgU1_OOAqWjiDU5Y/edit#). + +### Commit Message Format + +Each commit message consists of a **header**, a **body** and a **footer**. The header has a special +format that includes a **type**, a **scope** and a **subject**: + +``` +(): + + + +