mirror of
https://github.com/flakestorm/flakestorm.git
synced 2026-04-25 00:36:54 +02:00
Update README.md and CONTRIBUTING.md to enhance project visibility and support for new contributors. Added PyPI version and download badges, build status, and latest release information to README.md. Introduced a section in CONTRIBUTING.md for finding good first issues, providing guidance for beginners on how to contribute effectively.
This commit is contained in:
parent
d1aaa626c9
commit
2f4f2270b5
7 changed files with 266 additions and 0 deletions
|
|
@ -140,6 +140,26 @@ flakestorm/
|
|||
|
||||
## How to Contribute
|
||||
|
||||
### Finding Good First Issues
|
||||
|
||||
New to contributing? Look for issues labeled `good first issue` on GitHub. These are specifically curated for beginners and include:
|
||||
- Clear problem statements
|
||||
- Well-defined scope
|
||||
- Helpful guidance in the issue description
|
||||
- Good learning opportunities
|
||||
|
||||
To find them:
|
||||
1. Go to [Issues](https://github.com/flakestorm/flakestorm/issues)
|
||||
2. Filter by label: `good first issue`
|
||||
3. Read the issue description and ask questions if needed
|
||||
4. Comment on the issue to let others know you're working on it
|
||||
|
||||
**Note for Maintainers**: To add `good first issue` labels to beginner-friendly issues:
|
||||
- Look for issues that are well-scoped and have clear acceptance criteria
|
||||
- Add the `good first issue` label via GitHub's web interface
|
||||
- Ensure the issue description includes context and guidance for new contributors
|
||||
- Consider 5-10 issues at a time to give beginners options
|
||||
|
||||
### Reporting Bugs
|
||||
|
||||
1. Check existing issues first
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue