Skip to content

Start a contributor guide #2

@namurphy

Description

@namurphy

Since this needs to be a community-driven project, we should being a contributor guide that describes the steps needed to make a contribution. We can probably start this out in CONTRIBUTING.md, since that's the standard place that describes how to contribute.

The guide should include the following information, though it doesn't necessarily need to be all done in the first pull request (PR). I've included links from PlasmaPy's contributor guide (though PlasmaPy's docs are written in reStructuredText rather than MyST).

  • Getting ready to contribute
  • Contribution workflow
  • Quicker(?) contributions using the GitHub web interface?
  • MyST Markdown resources
  • The layout of the repository
  • How to add a page (including to the table of contents in myst.yml)
  • How to build the site locally with uv & Nox

It often helps to point to other resources that are well-maintained by others in the community, since that way we don't need to maintain it ourselves.

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions