Skip to content

Include CONTRIBUTING documentation #153

Open
@alestiago

Description

@alestiago

Describe what scenario you think is uncovered by the existing examples/articles
As a potential contributor, I would like to have a CONTRIBUTING.md file for each package within this mono repo. I would like this file to answer:

  1. How am I recommended to develop the package locally?
  2. How am I recommended to create a pull request?
  3. How am I recommended to test the package locally and with unit tests?
  4. Ideally, a list of "good first contributions" for new maintainers to start diving into the codebase.
  5. An overview of how does the package work (if non-trivial)? Include diagrams or visualisations?

Metadata

Metadata

Assignees

Labels

documentationImprovements or additions to documentation

Type

No type

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions