Housekeeping

[thewilloftheshadow]

Changes

• Adds two new issue templates
  • Bug Reports
  • Feature Requests
• Adds badges to the README.md (and therefore the front page of the docs)
• Adds a workflow to generate docs (untested because its hard to test on a fork)
• Adds a theme to the docs generator that gives it a bit better readability
• Adds a Code of Conduct
• Adds a Contributing guide
• Add a greeting to new contributors

Suggested Changes for the repo

I think that you should move this and the typings repo into their own GitHub Organization. This has a few perks: 1) It would allow both ease of use for you to be able to granuarly control permissions on repos without messing with your personal account 2) You would easily be able to transfer the projects in the future if this heads that way, just by giving organization control 3) You could better setup CI to automatically test for both linting and for running tests on the package automatically, and giving other contributors access to the test setups.

As well as this, if you do go with the organization setup, you could use this permission setup that I use in my own server.

• Owner
  • All code must be reviewed by this user to be merged into the package.
  • Owner of the organization
• Developer
  • This user can modify branches except the main branch that is published, they have to create PRs to be reviewed by the owner in order to merge into the main branch.
  • This user can manage issues (open, close, label)
  • This user is an organization member.
• User
  • Can fork the repo and create PRs
  • Normal GitHub user without organization membership

[not-so-smart]

would you mind moving the org suggestion to a new issue? this is about to be merged and closed