Update according to Contributors library guidelines by JordanMartinez · Pull Request #9 · purescript-contrib/purescript-http-methods

JordanMartinez · 2020-09-14T19:33:49Z

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

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.
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.
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.

Note: I don't think this repo needs any further docs, tests, or quick start guide. The source code and resulting documentation is pretty clear as is.

…oneyman`

.github/CONTRIBUTING.md

.github/workflows/ci.yml

README.md

thomashoneyman · 2020-09-14T22:09:03Z

README.md

+`http-methods` documentation is stored in a few places:
+
+1. Module documentation is [published on Pursuit](https://pursuit.purescript.org/packages/purescript-http-methods).
+2. Written documentation and [the changelog](./docs/CHANGELOG.md) are kept in [the docs directory](./docs).


If there's not much reason for a documentation directory we could perhaps just remove them and treat this as a special case. Perhaps we could add to the library summary the RFCs this is based on (HTTP/1.1 with RFC 2518 and RFC 5789)?

I'm up for removing the docs repo, but we would need to move the CHANGELOG.md file into the root folder.

Looks like we do need to move the CHANGELOG and the CONTRIBUTING files into the repository root. When doing that, we could remove this line altogether (because there won't be a docs directory anymore). Remember that we'll also need to fix the CONTRIBUTING link later in the README file.

I think leaving CONTRIBUTING.MD in the .github folder is a valid choice based on GH's help page. Whether we want to leave it there or move it to the root folder is a separate matter.

I think moving it to the root folder is better as it increases visibility of it.

README.md

docs/README.md

README.md

thomashoneyman · 2020-09-20T02:17:21Z

.github/CONTRIBUTING.md

@@ -0,0 +1,5 @@
+# Contributing to HTTP Methods


Mind moving this into the root of the repository?

thomashoneyman · 2020-09-20T02:18:16Z

README.md

+
+1. If you encounter a problem or have a question, please [open an issue](https://github.com/purescript-contrib/purescript-http-methods/issues). We'll do our best to work with you to resolve or answer it.
+
+2. If you would like to contribute code, tests, or documentation, please [read the contributor guide](./.github/CONTRIBUTING.md). It's a short, helpful introduction to contributing to this library, including development instructions.


We need to update this link to point at ./CONTRIBUTING.md instead.

JordanMartinez added 8 commits September 14, 2020 12:29

Migrate project to Spago

a834754

Capitalize .github/ files

3b7d09a

Remove old issue_template.md file

d3451e8

Remove .travis.yml file

e7de50e

Remove package.json file

2aa2369

Run `contrib-updater generate --maintainer garyb --maintainer thomash…

cfc9d6f

…oneyman`

Delete backups folder

f38908a

Remove the test/ directory

70d0a17