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

Update contributor docs #368

Open
1 of 8 tasks
mplanchard opened this issue Feb 2, 2021 · 6 comments
Open
1 of 8 tasks

Update contributor docs #368

mplanchard opened this issue Feb 2, 2021 · 6 comments

Comments

@mplanchard
Copy link
Contributor

mplanchard commented Feb 2, 2021

Contributor docs definitely could use some expansion. I'd like to add at least:

  • Architecture overview
  • Any standards and style guidelines we can't enforce with linting
  • Expectations for tests
  • Expectations for backwards compatibility
  • Guidelines for issue triage
  • Label interpretation / finding a good issue to work on
  • Deploy process

  • TODO add this to the v2 milestone when I'm not on mobile
@dee-me-tree-or-love
Copy link
Member

dee-me-tree-or-love commented Feb 2, 2021

I can pick it up
(Will be happy to do at least a part 👍)

@mplanchard mplanchard added this to the 2.0.0 milestone Feb 2, 2021
@mplanchard
Copy link
Contributor Author

Awesome! Feel free to pick up any part of it you feel comfortable with. Some of this stuff doesn't exist anywhere but in my head at this point, so also feel free to hit me up if you're blocked

@dee-me-tree-or-love
Copy link
Member

@mplanchard perfect, yes! I will pick up the architecture overview and maybe the deploy process as first candidates. But will take a closer look when picking it up these days :) I will poke you on Zulip if anything further.

@dee-me-tree-or-love
Copy link
Member

Will be adding documentation in this branch on my fork https://github.com/dee-me-tree-or-love/pypiserver/tree/368_update-contributor-docs_first-setup ✌️ any suggestions are welcome

@dee-me-tree-or-love
Copy link
Member

Adding another documentation area:

@dee-me-tree-or-love
Copy link
Member

Also related PR on documentation #451

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

No branches or pull requests

2 participants