Skip to content
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

Contributing guide page needs more context #438

Open
lwasser opened this issue Jan 15, 2025 · 1 comment
Open

Contributing guide page needs more context #438

lwasser opened this issue Jan 15, 2025 · 1 comment

Comments

@lwasser
Copy link
Member

lwasser commented Jan 15, 2025

I'm working on contributing to open source GitHub lessons for bssw and I want to link to a solid overview of the the importance of a thoughtful contributing guide in an open source or any code repository.

our packaging guide here needs some more love on this front. We could emphasize how this is a landing page for users who want to contribute. And if you want contributions, it's best to be as clear as possible and link to dev docs if you have them in the guide. The readme file should also link to this file.

I just ran through this contributing to PyPI. I figured things out because there were links to development docs and guidelines. We should update our overviewto include:

  1. Link to the contributing guide from the readme file (if that already doesn't exist)
  2. Mention that the contributing guide is a core landing page for contributors; it should make them clearly understand how they can contribute, the types of contributions you welcome, and what the process is.
  3. If there are development items that they need to do, follow, etc, it should also clearly link to those.
@lwasser
Copy link
Member Author

lwasser commented Jan 21, 2025

UPDATE: I'm working on this locally now to complement our contribute to open source series. I'll open it up for reviews once I get a PR online! 🚀

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant