search

purescript-contrib / purescript-coroutines

Computations which can suspend their execution and return control to their invoker
MIT License
38 stars 11 forks source link

Update according to Contributors library guidelines #33

Closed thomashoneyman closed 3 years ago

thomashoneyman commented 3 years ago

This pull request is part of an effort to update and standardize the Contributors libraries according to the Library Guidelines. Specifically, it:

  1. Adjusts the files and repository structure according to the repository structure section of the guidelines, which includes standard pr templates, issue templates, CI in GitHub Actions, ensures the project uses Spago, and so on.
  2. Updates the README and documentation according to the documentation section of the guidelines. This is a first step towards ensuring Contributors libraries have adequate module documentation, READMEs, a docs directory, and tests (even if just usage examples) in a test directory.
  3. Updates labels where relevant to help folks better sift through issues on this library and get started contributing.

This PR is the groundwork for followup efforts to ensure contributor libraries are kept up-to-date, documented, tested, and accessible to users and new contributors.

thomashoneyman commented 3 years ago

Well, looks like this should also update the test suite to not run an infinite test but rather to just run n times so that it can exit gracefully.

JordanMartinez commented 3 years ago

Yeah, the test suite is the only other thing this PR should update. Or perhaps that should be covered in a separate PR?

thomashoneyman commented 3 years ago

I'd like to update it in this PR, just so that we don't have the main branch with a failing build in the meantime. Glad it otherwise looks good!