Skip to content

DOC: Clarify ‘Discussion and Development’ Section on Project README #53507

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
1 task done
ssharp0 opened this issue Jun 2, 2023 · 1 comment · Fixed by #53509
Closed
1 task done

DOC: Clarify ‘Discussion and Development’ Section on Project README #53507

ssharp0 opened this issue Jun 2, 2023 · 1 comment · Fixed by #53509
Assignees
Labels
Docs Needs Triage Issue that has not been reviewed by a pandas team member

Comments

@ssharp0
Copy link
Contributor

ssharp0 commented Jun 2, 2023

Pandas version checks

  • I have checked that the issue still exists on the latest versions of the docs on main here

Location of the documentation

https://github.com/pandas-dev/pandas/blob/main/README.md

Documentation problem

I wanted to provide an idea and suggestion with the aim of clarifying the ‘Discussion and Development’ Section on the project README. I do not see a related issue in the ‘issues’ tab.

Currently, I don't see a direct and easily discoverable navigation link to the contributor community webpage in this section. I also did not see mention of the community meetings. I think providing this information on the README could be a helpful resource for new contributors looking to better understand the available communication methods.

Contributor Community Webpage: https://pandas.pydata.org/docs/dev/development/community.html#

Below is the current 'Discussion and Development' Section on main for reference:

Screenshot 2023-06-02 at 2 28 30 PM

Suggested fix for documentation

In the 'Discussion and Development' section I would suggest adding a link to the contributor community webpage and also mention the community meetings.

I initially found the section a bit confusing as I wasn’t aware of the contributor community web page and the community meetings until I discovered it later. Currently, a user can click on the “Slack channel” link to find the contributors community web page. But it may not be immediately clear or intuitive as someone may be looking for something more direct. I believe adding this clarification could help align sources and serve as a useful resource for new contributors.

Below is the suggested update:

Discussion and Development

Most development discussions take place on GitHub in this repo, via the GitHub issue tracker.

Further, the pandas-dev mailing list can also be used for specialized discussions or design issues, and a Slack channel is available for quick development related questions.

There are also frequent community meetings for project maintainers open to the community as well as monthly new contributor meetings to help support new contributors.

Additional information on the communication channels can be found on the contributor community page.

@ssharp0 ssharp0 added Docs Needs Triage Issue that has not been reviewed by a pandas team member labels Jun 2, 2023
@ssharp0
Copy link
Contributor Author

ssharp0 commented Jun 2, 2023

take

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Docs Needs Triage Issue that has not been reviewed by a pandas team member
Projects
None yet
Development

Successfully merging a pull request may close this issue.

1 participant