Skip to content

Commit 3b9ea71

Browse files
authored
docs: Add good first issue section (#59)
* Add 'Good First Issues' section to README Added a section for 'Good First Issues' to guide new contributors. Signed-off-by: freya-docs <freya.docs.pp@gmail.com> * Fix grammar in Good First Issues section Corrected punctuation and improved sentence structure for clarity. Signed-off-by: freya-docs <freya.docs.pp@gmail.com> --------- Signed-off-by: freya-docs <freya.docs.pp@gmail.com> Signed-off-by: xingzihai
1 parent 9d0149b commit 3b9ea71

1 file changed

Lines changed: 15 additions & 0 deletions

File tree

README.md

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -251,6 +251,21 @@ The following error cases are implemented:
251251
| **Set Default Card** | 404 | `{ error: 'Card not found' }` — when card ID doesn't exist or doesn't belong to authenticated user |
252252
| **Successful Deletion** | 204 | No content |
253253

254+
## Good First Issues
255+
256+
New to open source? We've got you covered! Check out our [Good First Issues](https://github.com/Dev-Card/DevCard/issues?q=is%3Aopen+label%3A%22good-first-issue%22), these are specially curated issues that are:
257+
258+
- Well-documented with clear acceptance criteria
259+
- Limited in scope (perfect for a first contribution)
260+
- Mentored by maintainers
261+
262+
### How to Claim an Issue
263+
264+
1. Browse the [Good First Issues list](https://github.com/Dev-Card/DevCard/issues?q=is%3Aopen+label%3A%22good-first-issue%22).
265+
2. Comment on the issue you'd like to work on (e.g., "I'd like to take this on!") and wait for a maintainer to assign it to you.
266+
3. If you feel like opening the PR first, you can do that, and you will be assigned accordingly.
267+
4. Fork the repo, make your changes, and open a PR.
268+
254269
## Contributing
255270

256271
See [CONTRIBUTING.md](./CONTRIBUTING.md) for setup instructions, coding standards, and PR process.

0 commit comments

Comments
 (0)