-
Notifications
You must be signed in to change notification settings - Fork 0
Open
Description
https://github.com/purescript-contrib/governance/blob/main/library-guidelines.md
Libraries in the Contributors organization are expected to:
- Have at least one (and preferably more) assigned maintainers, as indicated by badges in the project README.
- Have adequate documentation in the form of module documentation published to Pursuit, a README containing a library summary, installation instructions, and more, and a docs directory containing at least a short tutorial (see the documentation section below).
- Have a CHANGELOG.md in the root directory.
- Have an adequate test suite which is exercised by continuous integration (see the tests section below)
- Use the standard Contributors repository structure, which can be generated with the contrib-updater tool (see the repository structure section below).
- Use a default branch of main for the repository.
TODO
- Add maintainer badge
- Split documentation into a "quick start" (to keep in
README.md) and the rest of examples could go indocs - Link to TryPureScript for quick start and
docs/README.mdexamples - Generate
CHANGELOG(usingpurescript-contrib/chnglg)
A .github directory containing issue templates, pull request templates, contributing guide, and workflows for tests in continuous integration and automatically labeling stale issues and pull requests.
- Issue template
- PR template
- Contributing guide
Metadata
Metadata
Assignees
Labels
No labels