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

add default documentation to this repo #4

Open
4 tasks
MathewBiddle opened this issue Sep 10, 2024 · 1 comment
Open
4 tasks

add default documentation to this repo #4

MathewBiddle opened this issue Sep 10, 2024 · 1 comment

Comments

@MathewBiddle
Copy link

To encourage participation and/or simply document how this repository functions, I recommend adding a few standard documentation pieces to this repository.

For more information on each of the below items, see https://opensource.guide/starting-a-project/#launching-your-own-open-source-project

  • LICENSE (I see two in this repo, which one is the authoritative one?)
  • add a README.md with context (answering some questions such as; What does this project do? Why is this project useful? How do I get started? Where can I get more help, if I need it?)
  • contributing guidelines (CONTRIBUTING.md)
  • code of conduct (CODE_OF_CONDUCT.md)
@ianjonsen
Copy link
Owner

In progress...

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants