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

docs: add the start of a contributor's guide #1741

Draft
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

JohnVillalovos
Copy link
Member

Create an initial contributor's guide that will hopefully be expanded
on in the future.

@JohnVillalovos JohnVillalovos force-pushed the jlvillal/devel_docs branch 4 times, most recently from 38d4398 to 5af101c Compare December 16, 2021 01:25
@JohnVillalovos JohnVillalovos force-pushed the jlvillal/devel_docs branch 2 times, most recently from 60b80ed to 3d1a075 Compare December 25, 2021 16:52
@JohnVillalovos JohnVillalovos force-pushed the jlvillal/devel_docs branch 2 times, most recently from 6520a42 to 44780e9 Compare January 3, 2022 06:42
Create an initial contributor's guide that will hopefully be expanded
on in the future.
@nejch
Copy link
Member

nejch commented Jan 9, 2022

Thanks a lot @JohnVillalovos! Just one initial concern I have in general is that this somewhat duplicates https://github.com/python-gitlab/python-gitlab/blob/main/CONTRIBUTING.rst. Can we combine these somehow? the root-level one should probably be more concise and link to more details I guess, but have enough info for a quickstart.

For example, I noticed the same kind of duplication with README.rst and our install instructions and intro etc, so I ended up just linking the repo file in the docs. Would that make sense to avoid having to update things twice?

@JohnVillalovos JohnVillalovos marked this pull request as draft February 12, 2022 16:53
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

Successfully merging this pull request may close these issues.

None yet

2 participants