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.

Sign up for GitHub

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

Jump to bottom

Include CONTRIBUTING documentation #153

Open
alestiago opened this issue May 23, 2023 · 0 comments
Open

Include CONTRIBUTING documentation #153

alestiago opened this issue May 23, 2023 · 0 comments
Assignees
@rrousselGit
Labels
documentation Improvements or additions to documentation

Comments

@alestiago
Copy link

alestiago commented May 23, 2023 •
edited

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?
@alestiago alestiago added the documentation Improvements or additions to documentation label May 23, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@rrousselGit rrousselGit

Labels
documentation Improvements or additions to documentation
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
2 participants
@rrousselGit @alestiago