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

Create contributing guide #100

Open
bswck opened this issue Dec 7, 2023 · 3 comments
Open

Create contributing guide #100

bswck opened this issue Dec 7, 2023 · 3 comments

Comments

@bswck
Copy link
Contributor

bswck commented Dec 7, 2023

Before I read the article about skeleton, I was confused about various files such as *.egg-info etc. not being automatically excluded by .gitignore in one of the downstream skeleton projects, because repo-local .gitignore files are a very common practice nowadays.

Only later I found this https://blog.jaraco.com/skeleton/#ignoring-artifacts.

Making a simple guide for new contributors might be helpful to get them started and prevent from commiting files they don't intend to commit.

@jaraco
Copy link
Owner

jaraco commented Dec 19, 2023

Good idea. I've been thinking about expanding the skeleton docs to include a section on "expectations from the user" or "user guide", part of which would be the ignoring artifacts section. The real trick is going to be how to surface this documentation to users (without complicating the downstream projects). Perhaps the skeleton badge is enough or maybe a CONTRIBUTING.md is in order. Let me know what you're thinking.

@webknjaz
Copy link
Contributor

So some time ago, as I was writing https://ansible-pylibssh.readthedocs.io/en/latest/contributing/guidelines/ and was thinking of how much of that I'm copying over into other projects. I also wanted something similar in the context of sphinxcontrib-towncrier.
I had an idea to have a Sphinx extensions that would inject such pages automatically, generating them in-memory. It turned out, though, that Sphinx doesn't allow making up document paths and filters them out if there's no corresponding documents on disk, which is a shame. I've been meaning to contribute this to Sphinx ever since, but never found time...
Still, I think that the concept may be quite useful on the larger scale.

@jaraco
Copy link
Owner

jaraco commented Aug 20, 2024

In python/cpython#123144, I realized that much of what's needed in a contribution guide is presented in the skeleton guide, and maybe it would make sense, in order to increase visibility, to rename the badge to "contributing" and re-organize the primary guide to be first about contributing and secondarily about maintenance.

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

3 participants