Skip to content

Ecosystem-level tutorial / documentation content #21

Open

Description

@drammock

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)

Activity

  1. self-assigned this
    on Apr 20, 2023
  2. self-assigned this
    on Apr 20, 2023
  3. self-assigned this
    on Apr 27, 2023
  4. self-assigned this
    on May 2, 2023
  5. juanis2112 commented on May 19, 2023

    @juanis2112
    Member

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

  6. drammock commented on May 25, 2023

    @drammock
    MemberAuthor

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

  7. removed their assignment
    on Jul 7, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Labels

No labels
No labels

Type

No type

Projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions