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

Ecosystem-level tutorial / documentation content #21

Open
drammock opened this issue Apr 20, 2023 · 2 comments
Open

Ecosystem-level tutorial / documentation content #21

drammock opened this issue Apr 20, 2023 · 2 comments
Assignees

Comments

@drammock
Copy link

Splitting this off from the issue of tutorial infrastructure (#9). There are lots of things that don't need separate documentation for each package; things like

  • standard GitHub setup for contributors (fork, clone, add upstream, don't open PRs from main, etc)
  • explanation of CIs and how to view their logs
  • project management / workflows. This one is more aimed at maintainers, and has the goal of making it easier for contributors from other parts of the ecosystem to jump in and contribute to other packages without too much friction. Here I'm thinking of things like pre-commit setup, PR merge criteria, etc: probably there won't be general agreement on something like PR merge criteria across the ecosystem, but we could at least agree upon a standard place to write down what the PR merge policy is, so that a new contrib could easily find that information (CONTRIBUTING.md?) regardless of what package they happen to be contributing to.

obviously there will be some degree of variability across packages in how each of these things are done, but that's an opportunity for figuring out which ones have a clear best-practice (that could be codified in a SPEC?) and which are cases of "reasonable packages will disagree". For the latter cases, the ecosystem-level tutorial would be either more conceptual (individual package docs fill in the details) or simply not exist.

cc @lwasser who is planning tutorials about packaging I think

Originally posted by @drammock in #9 (comment)

@mdhaber mdhaber self-assigned this Apr 20, 2023
@drammock drammock self-assigned this Apr 20, 2023
@juanis2112 juanis2112 self-assigned this Apr 27, 2023
@crazy4pi314 crazy4pi314 self-assigned this May 2, 2023
@MSanKeys963 MSanKeys963 self-assigned this May 8, 2023
@juanis2112
Copy link
Member

Hackmd link for the summit: https://hackmd.io/YL5DNtsaSsS-1ZU3Pxkrxg

@drammock
Copy link
Author

Here's another HackMD brainstorming some content for the "contributor-to-maintainer" transition: https://hackmd.io/SmgooiRHRu20TF6zJPF6hA that @munkm and I started

@crazy4pi314 crazy4pi314 removed their assignment Jul 7, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
Status: No status
Development

No branches or pull requests

5 participants