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

Bring into compliance with PureScript Contributors Library Guidelines #21

Open
7 tasks
pete-murphy opened this issue Dec 25, 2023 · 0 comments
Open
7 tasks

Comments

@pete-murphy
Copy link
Owner

pete-murphy commented Dec 25, 2023

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
    Maintainer: pete-murphy
  • Split documentation into a "quick start" (to keep in README.md) and the rest of examples could go in docs
  • Link to TryPureScript for quick start and docs/README.md examples
  • Generate CHANGELOG (using purescript-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
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

1 participant