Skip to content

Update according to Contributors library guidelines#22

Merged
thomashoneyman merged 9 commits into
purescript-contrib:mainfrom
JordanMartinez:contrib
Sep 13, 2020
Merged

Update according to Contributors library guidelines#22
thomashoneyman merged 9 commits into
purescript-contrib:mainfrom
JordanMartinez:contrib

Conversation

@JordanMartinez

Copy link
Copy Markdown
Contributor

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.

@thomashoneyman

thomashoneyman commented Sep 13, 2020

Copy link
Copy Markdown
Contributor

@JordanMartinez Do you mind using freet (or FreeT, if you'd like) as the package name instead of 'purescript-freet'? There are only a few places it's used in the README files, so it would be a quick update. Otherwise this looks good!

@JordanMartinez

Copy link
Copy Markdown
Contributor Author

I'll use freet.

Comment thread .github/CONTRIBUTING.md Outdated
Comment thread README.md Outdated
Comment thread README.md Outdated
Comment thread README.md Outdated
Comment thread docs/README.md Outdated
@thomashoneyman

Copy link
Copy Markdown
Contributor

I think we ought to refer to packages without prefixes; while purescript- was in there originally for disambiguation in the Bower registry, it's not used in Spago and as a whole our tooling is moving towards dropping the prefix except for repository names themselves.

@JordanMartinez

Copy link
Copy Markdown
Contributor Author

I think we ought to refer to packages without prefixes; while purescript- was in there originally for disambiguation in the Bower registry, it's not used in Spago and as a whole our tooling is moving towards dropping the prefix except for repository names themselves.

Gotcha. That makes more sense now.

@JordanMartinez

Copy link
Copy Markdown
Contributor Author

Done.

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