Skip to content

Update according to Contributors library guidelines#75

Merged
thomashoneyman merged 4 commits into
purescript-contrib:mainfrom
deviant-forks:contrib
Oct 8, 2020
Merged

Update according to Contributors library guidelines#75
thomashoneyman merged 4 commits into
purescript-contrib:mainfrom
deviant-forks:contrib

Conversation

@maxdeviant

Copy link
Copy Markdown
Member

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, automatic stale issue management, 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.

@maxdeviant

Copy link
Copy Markdown
Member Author

Verified that spago build and spago test are working:

λ spago build
[info] Installation complete.
[info] Build succeeded.
λ spago test
[info] Installation complete.
[info] Build succeeded.
[info] Tests succeeded.

I also tried out to the two existing npm scripts (npm run test:browser and npm run test:serve) and these both seemed to work.

@thomashoneyman

Copy link
Copy Markdown
Contributor

Mind deleting the lockfile?

@maxdeviant

Copy link
Copy Markdown
Member Author

Lockfile has been removed and added to .gitignore.

@thomashoneyman thomashoneyman merged commit b029f20 into purescript-contrib:main Oct 8, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Development

Successfully merging this pull request may close these issues.

2 participants