Skip to content

Update library to Contributors library standards #16

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.

Sign up for GitHub

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

Jump to bottom
Merged
merged 4 commits into from
Oct 6, 2020
Merged

Update library to Contributors library standards #16

merged 4 commits into from
Oct 6, 2020

Conversation

maxdeviant
Copy link
Member

This PR updates purescript-arraybuffer-types to adhere to the Contributors library guidelines.

This is part of the purescript-contrib/governance#13 effort.

@maxdeviant
Copy link
Member Author

Confirmed that spago build is working as expected:

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

Once this PR gets merged I'll add issues for the following outstanding items:

  • Adding a "quick start" guide
  • Adding tests

thomashoneyman
thomashoneyman reviewed Oct 4, 2020
View reviewed changes
README.md Outdated

1. Module documentation is [published on Pursuit](https://pursuit.purescript.org/packages/purescript-arraybuffer-types).
2. Written documentation is kept in the [docs directory](./docs).
3. Usage examples can be found in [the test suite](./test).
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We can remove parts of this section which aren't relevant for a library (for example, this one doesn't have tests and so we should remove that line. It probably doesn't need a docs directory, either).

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Other than that, this looks good!

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Alright, I removed the docs directory and the references to docs and test in the README.

thomashoneyman
thomashoneyman reviewed Oct 6, 2020
View reviewed changes
README.md Outdated
@@ -25,8 +25,6 @@ The quick start hasn't been written yet (contributions are welcome!). The quick
`arraybuffer-types` documentation is stored in a few places:

1. Module documentation is [published on Pursuit](https://pursuit.purescript.org/packages/purescript-arraybuffer-types).
Copy link
Contributor

@thomashoneyman thomashoneyman Oct 6, 2020 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Given there is only one of these left, what if we just merge this with the prior sentence? Then there would be no numbered list.

“Module documentation for arraybuffer-types ...”

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I merged the sentences per your suggestion.

I also cleaned up another spot that was referring to the docs directory.

@thomashoneyman thomashoneyman merged commit bdb612f into purescript-contrib:main Oct 6, 2020
@maxdeviant maxdeviant mentioned this pull request Oct 6, 2020
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@thomashoneyman thomashoneyman thomashoneyman left review comments

Assignees
No one assigned
Labels
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@maxdeviant @thomashoneyman