-
Notifications
You must be signed in to change notification settings - Fork 24
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
* feat: 2.0.4 document * feat: add notice in README.md * docs: add new issue template * feat: edit new README.md * docs: update pr template
- Loading branch information
1 parent
7fc749a
commit d3ada34
Showing
13 changed files
with
277 additions
and
64 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,57 @@ | ||
| ### Git Commit Rule | ||
|
|
||
| > This is adapted from [Angular's commit convention](https://github.com/conventional-changelog/conventional-changelog/tree/master/packages/conventional-changelog-angular). | ||
| Git commits should adhere to the following rule to automatically generate changelogs: | ||
|
|
||
| ``` | ||
| # Follow the Angular commit conventional format | ||
| /^(revert: )?(feat|fix|docs|refactor|perf|test|workflow|ci|chore|types)(\(.+\))?: .{1,50}/ | ||
| ``` | ||
|
|
||
| We utilize three tags to simplify the rules: | ||
|
|
||
| - `feat:` for new features | ||
| - `fix:` for bug fixes | ||
| - `doc:` for documentation changes. | ||
|
|
||
| ### Git Flow (Branch Rule) | ||
|
|
||
| ```mermaid | ||
| %%{init: { 'logLevel': 'debug', 'theme': 'base', 'gitGraph': {'showBranches': true, 'showCommitLabel':true,'mainBranchName': "main" }} }%% | ||
| gitGraph | ||
| commit | ||
| commit tag: "v1.0.0" | ||
| branch "develop(gitlab)" | ||
| checkout "develop(gitlab)" | ||
| branch version | ||
| checkout version | ||
| branch feat/featureExample | ||
| checkout feat/featureExample | ||
| commit | ||
| commit | ||
| checkout version | ||
| merge feat/featureExample | ||
| branch fix/fixExample | ||
| checkout fix/fixExample | ||
| commit | ||
| commit | ||
| checkout version | ||
| merge fix/fixExample | ||
| branch docs/docsExample | ||
| checkout docs/docsExample | ||
| commit | ||
| commit | ||
| checkout version | ||
| merge docs/docsExample | ||
| checkout "main" | ||
| merge version tag: "v1.0.1" | ||
| commit | ||
| ``` | ||
|
|
||
| - `feat/<yourBranchName>` ：develop new feature | ||
| - `fix/<yourBranchName>`：edit old feature | ||
| - `docs/<yourBranchName>` ：add docs or example | ||
| - `<version>` : the version before release ex. 2.0.0 | ||
| - `develop` ：only for gitlab branch, for rebase github master branch. Not exist in github develop flow | ||
| - `master` ：github main branch, only update by merge request |
File renamed without changes.
This file was deleted.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,81 @@ | ||
| name: 🐛 Bug Report | ||
| description: Report a bug in bdk | ||
| labels: ['type:bug', 'priority:high'] | ||
| assignees: 'kidneyweakx' | ||
|
|
||
| body: | ||
| - type: markdown | ||
| attributes: | ||
| value: | | ||
| This template is for the unexpected errors or bugs in bdk. If you have a question, please ask in questions section in issues. | ||
| - type: dropdown | ||
| attributes: | ||
| label: 影響範圍 Which area(s) are affected? (Select all that apply) | ||
| multiple: true | ||
| options: | ||
| - 'Not sure' | ||
| - 'Fabric' | ||
| - 'Fabric-CA' | ||
| - 'Fabric-Chaincode' | ||
| - 'Fabric-Explorer' | ||
| - 'Quorum' | ||
| - 'Quorum-Remote' | ||
| - 'Quorum-Explorer' | ||
| - 'Docker' | ||
| - 'Dockerode' | ||
| - 'Node.js' | ||
| - 'Workflows(CI/CD)' | ||
|
|
||
| - type: textarea | ||
| attributes: | ||
| label: 測試環境 Provide environment information | ||
| description: Please list your operating system, Node.js version, npm version, | ||
| render: bash | ||
| placeholder: | | ||
| BDK: | ||
| Version: 2.0.4 | ||
| Operating System: | ||
| Platform: macOS | ||
| Arch: arm64 | ||
| Version: Darwin Kernel Version 22.5.0 | ||
| Binaries: | ||
| Node: 16.13.2 | ||
| npm: 9.5.1 | ||
| Docker: | ||
| client: 24.0.5 | ||
| compose: 2.20.2-desktop.1 | ||
| validations: | ||
| required: true | ||
|
|
||
| - type: textarea | ||
| attributes: | ||
| label: 重現步驟 To Reproduce | ||
| description: A step-by-step description of how to reproduce the issue, based on the linked reproduction. Screenshots can be provided in the issue body below. If using code blocks, make sure that [syntax highlighting is correct](https://docs.github.com/en/get-started/writing-on-github/working-with-advanced-formatting/creating-and-highlighting-code-blocks#syntax-highlighting) and double check that the rendered preview is not broken. | ||
| placeholder: | | ||
| 1. Start quorum node | ||
| 2. Start quorum explorer | ||
| validations: | ||
| required: true | ||
|
|
||
| - type: textarea | ||
| attributes: | ||
| label: 應呈現結果 Expected Behavior | ||
| description: Please describe the behavior expected. | ||
| placeholder: | | ||
| Should open a explorer in browser | ||
| - type: textarea | ||
| attributes: | ||
| label: 實際呈現結果 Resulted Behavior | ||
| description: Please describe the behavior that actually occurred. | ||
| placeholder: | | ||
| explorer not open in browser | ||
| - type: checkboxes | ||
| attributes: | ||
| label: 驗證版本 Verify bdk release | ||
| description: 'Please run `bdk --version` besure you are using the latest version.' | ||
| options: | ||
| - label: I verified that my version is the stable release or 1.0.4 | ||
| required: true |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,34 @@ | ||
| name: 📃 Docs Improvement | ||
| description: Docs error in bdk | ||
| labels: ['type:docs', 'priority:low'] | ||
|
|
||
| body: | ||
| - type: markdown | ||
| attributes: | ||
| value: | | ||
| This template is for the docs/example error in bdk. If you have a question, please ask in questions section in issues. | ||
| - type: markdown | ||
| attributes: | ||
| value: Thank you for helping us improve the docs! | ||
|
|
||
| - type: textarea | ||
| attributes: | ||
| label: What is the improvement or update you wish to see? | ||
| description: 'Example: I would like to see more examples of how to use quorum node.' | ||
| validations: | ||
| required: true | ||
|
|
||
| - type: textarea | ||
| attributes: | ||
| label: Is there more context that might help us understand? | ||
| description: A clear description about the suggestion. | ||
| validations: | ||
| required: true | ||
|
|
||
| - type: input | ||
| attributes: | ||
| label: Does the docs page already exist? Please link to it. | ||
| description: 'Example: https://github.com/cathayddt/bdk/wiki/link' | ||
| validations: | ||
| required: false |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,29 @@ | ||
| name: 🛠️ Feature Request | ||
| description: Request a feature in bdk | ||
| labels: ['type:feature', 'priority:medium'] | ||
|
|
||
| body: | ||
| - type: markdown | ||
| attributes: | ||
| value: | | ||
| This template is for feature requests in bdk. If you have a question, please ask in questions section in issues. | ||
| - type: textarea | ||
| attributes: | ||
| label: What is the problem that you are trying to solve? | ||
| description: A clear and concise description of what the problem is. Ex. I'm always frustrated when [...] | ||
| validations: | ||
| required: true | ||
|
|
||
| - type: textarea | ||
| attributes: | ||
| label: 新功能 Feature Request | ||
| description: Reason for this Feature | ||
| validations: | ||
| required: true | ||
|
|
||
| - type: textarea | ||
| attributes: | ||
| label: 可能的解法 Proposed Solution | ||
| validations: | ||
| required: true |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,16 @@ | ||
| name: ❓ Question | ||
| description: Ask a question in bdk | ||
| labels: ['type:question', 'priority:low'] | ||
|
|
||
| body: | ||
| - type: markdown | ||
| attributes: | ||
| value: | | ||
| This template is for questions in bdk. Feel free to ask any questions about bdk. | ||
| - type: textarea | ||
| attributes: | ||
| label: What is the question? | ||
| description: A clear and concise description of what the question is. | ||
| validations: | ||
| required: true |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1 @@ | ||
| blank_issues_enabled: false |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.