Clarification suggestion regarding GitHub support statement in README

Open
#737 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty
1/5
Estimated time
Under an hour
Newbie friendliness
45/100
Issue type
Documentation
Clarity
Mostly clear
Activity status
Stale
Domain
documentation

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.

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!

Dominant language
Jupyter Notebook
Stars
5.2k
Forks
5.3k
Avg merge
4d 10h
Merged PRs (30d)
10

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from realpython/materials

All issues in realpython/materials

Similar issues

More Documentation issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.