magbanum / magbanum/Python-Community-Discussions
Help me improve README files
Open
Nobody has claimed this yet.
documentation
enhancement
good first issue
Hacktoberfest
help wanted
- Dominant language
- No language data
- Stars
- 16
- Forks
- 18
- PR merge metrics
- No merged PRs in 30d
Description
Suggest the proper documentation for this repository. We can discuss it here or Pull Requests are always welcomed.
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start by reviewing the repository's README files and the existing project description to identify what documentation is missing or needs improvement. Use the issue discussion to propose the needed documentation, and consider submitting the agreed changes through a pull request. Done means the documentation proposal has been reviewed and the README updates are accepted.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 25/100