realpython / realpython/materials
Clarification suggestion regarding GitHub support statement in README
Nobody has claimed this yet.
- Dominant language
- Jupyter Notebook
- Stars
- 5.2k
- Forks
- 5.3k
- Avg merge
- 4d 10h
- Merged PRs (30d)
- 10
Description
Hi 👋,
While reviewing the README, I noticed the following line:
"Due to time constraints, we cannot provide 1:1 support via GitHub."
For new contributors, it might not be immediately clear whether this refers only to general support questions or also to issue discussions and pull request reviews.
Would it be helpful to clarify that contributors are still welcome to open issues and pull requests related to improvements in the repository?
I’d be happy to help refine the wording if needed.
Thanks for maintaining this project!
Contributor guide
No contributing guide indexed for this repository
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 in the README at the quoted GitHub support statement. Clarify whether the limitation covers general support only or also issue discussions and pull request reviews, and consider wording that welcomes repository improvement contributions; the README should make that distinction unambiguous.
Written by the indexing model from the issue text.
Assessment
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 1/5
- Estimated time
- Under an hour
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 45/100