|
| 1 | +name: Good First Issue |
| 2 | +description: Create a Good First Issue for new contributors |
| 3 | +title: "[Good First Issue]: " |
| 4 | +labels: ["good first issue"] |
| 5 | +assignees: [] |
| 6 | +body: |
| 7 | + - type: markdown |
| 8 | + attributes: |
| 9 | + value: | |
| 10 | + --- |
| 11 | + ## **Thanks for creating a good first issue!** 😊 |
| 12 | +
|
| 13 | + We truly appreciate your time and effort. This template helps create a **Good First Issue (GFI)**: a small, well-scoped task that helps new contributors learn the codebase and workflow. |
| 14 | + --- |
| 15 | +
|
| 16 | + - type: textarea |
| 17 | + id: intro |
| 18 | + attributes: |
| 19 | + label: 🆕🐥 Newcomer Friendly |
| 20 | + description: Who is this issue for? |
| 21 | + value: | |
| 22 | + This **[Good First Issue](https://github.com/hyperledger-labs/fabric-token-sdk/issues?q=is%3Aissue%20state%3Aopen%20label%3A%22good%20first%20issue%22)** is a guided, well-scoped task intended for new human contributors to the Fabric Token SDK. |
| 23 | +
|
| 24 | + #### What you’ll do |
| 25 | + - ✅ Understand the project structure |
| 26 | + - ✅ Practice the standard Hyperledger contribution workflow |
| 27 | + - ✅ Submit and merge your first Pull Request |
| 28 | +
|
| 29 | + #### Support |
| 30 | + A maintainer or mentor actively monitors this issue and will help **guide it to completion**. |
| 31 | +
|
| 32 | + > [!IMPORTANT] |
| 33 | + > **This issue does not require deep blockchain knowledge.** |
| 34 | + > - No prior Hyperledger Fabric experience needed |
| 35 | + > - **Basic Go and Git are sufficient** |
| 36 | +
|
| 37 | + > [!NOTE] |
| 38 | + > ⏱️ **Typical time to complete:** 30–90 minutes (once setup is done) |
| 39 | + > 🧩 **Difficulty:** Small, well-contained change |
| 40 | + > 🎓 **Best for:** New contributors |
| 41 | +
|
| 42 | + - type: textarea |
| 43 | + id: issue |
| 44 | + attributes: |
| 45 | + label: 👾 Issue description |
| 46 | + description: | |
| 47 | + Describe the issue clearly. Explain why this change is useful. |
| 48 | + Avoid jargon where possible. Links to code are very welcome. |
| 49 | + placeholder: | |
| 50 | + Describe the problem here... |
| 51 | + validations: |
| 52 | + required: true |
| 53 | + |
| 54 | + - type: textarea |
| 55 | + id: solution |
| 56 | + attributes: |
| 57 | + label: 💡 Proposed Solution |
| 58 | + description: Describe what a good solution looks like at a high level. |
| 59 | + placeholder: | |
| 60 | + Briefly explain the fix... |
| 61 | + validations: |
| 62 | + required: true |
| 63 | + |
| 64 | + - type: textarea |
| 65 | + id: implementation |
| 66 | + attributes: |
| 67 | + label: 🛠️ Implementation Steps |
| 68 | + description: | |
| 69 | + Provide guided steps to help the contributor: |
| 70 | + - Which files to change |
| 71 | + - Which functions are involved |
| 72 | + - Expected output/result |
| 73 | + value: | |
| 74 | + - [ ] Step 1: ... |
| 75 | + - [ ] Step 2: ... |
| 76 | + - [ ] Step 3: Verify with `make unit-tests` |
| 77 | + validations: |
| 78 | + required: true |
| 79 | + |
| 80 | + - type: textarea |
| 81 | + id: setup_guide |
| 82 | + attributes: |
| 83 | + label: 📋 Setup Guide |
| 84 | + description: Quick links for setting up the environment. |
| 85 | + value: | |
| 86 | + #### Setup the Fabric Token SDK |
| 87 | + - [ ] **Fork & Clone**: Follow the [Contributing Guide](https://github.com/hyperledger-labs/fabric-token-sdk/blob/main/CONTRIBUTING.md) |
| 88 | + - [ ] **Install Tools**: Run `make install-tools` |
| 89 | + validations: |
| 90 | + required: true |
| 91 | + |
| 92 | + - type: textarea |
| 93 | + id: contribution_workflow |
| 94 | + attributes: |
| 95 | + label: 📋 Contribution Workflow |
| 96 | + description: Step-by-step for new contributors. |
| 97 | + value: | |
| 98 | + - [ ] **Claim the issue**: Comment "I would like to work on this" to be assigned. |
| 99 | + - [ ] **Create a branch**: `git checkout -b feature/my-fix` |
| 100 | + - [ ] **Implement & Test**: Run `make unit-tests` or specific integration tests. |
| 101 | + - [ ] **Commit with DCO**: Use `git commit -s -m "feat: description"` (The `-s` is mandatory). |
| 102 | + - [ ] **Push & PR**: Push to your fork and open a Pull Request. |
| 103 | + validations: |
| 104 | + required: true |
| 105 | + |
| 106 | + - type: textarea |
| 107 | + id: acceptance_criteria |
| 108 | + attributes: |
| 109 | + label: ✅ Acceptance Criteria |
| 110 | + value: | |
| 111 | + - [ ] The issue is solved as described. |
| 112 | + - [ ] Unit tests pass (`make unit-tests`, `make unit-tests-race`, and `make unit-tests-regression`). |
| 113 | + - [ ] Linting passes (`make lint` and `make checks`). |
| 114 | + - [ ] Commits are signed off (`-s`). |
| 115 | + validations: |
| 116 | + required: true |
| 117 | + |
| 118 | + - type: textarea |
| 119 | + id: getting_help |
| 120 | + attributes: |
| 121 | + label: 🧭 Getting Help |
| 122 | + value: | |
| 123 | + If you get stuck, don't hesitate to ask! |
| 124 | + - Comment on this issue. |
| 125 | + - Join us on **Discord**: [#fabric-token-sdk](https://discord.gg/hyperledger) |
| 126 | +
|
| 127 | + - type: markdown |
| 128 | + attributes: |
| 129 | + value: | |
| 130 | + --- |
| 131 | + ### 📚 Useful Resources |
| 132 | + - [Documentation Overview](https://github.com/hyperledger-labs/fabric-token-sdk/blob/main/docs/README.md) |
| 133 | + - [Development Guidelines](https://github.com/hyperledger-labs/fabric-token-sdk/blob/main/docs/development/development.md) |
| 134 | + - [Testing Guide](https://github.com/hyperledger-labs/fabric-token-sdk/blob/main/docs/development/testing.md) |
0 commit comments