Skip to content
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.

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

Update according to Contributors library guidelines #26

Merged
merged 7 commits into from
Sep 14, 2020

Conversation

JordanMartinez
Copy link
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
Copy link
Contributor

Maybe we should add the backups directory to the gitignore 😅

@JordanMartinez
Copy link
Contributor Author

Nah... It's helpful when reviewing things one last time. I just forgot to remove those.

@JordanMartinez
Copy link
Contributor Author

JordanMartinez commented Sep 14, 2020

I think the only issue that can be opened on this repo is adding more docs. Would you mind if I just add that here rather than open a new PR for it?

Docs would include:

  • clarifying what the These type is (basically reuse the readme's description)
  • documenting what the instances do by providing examples

@thomashoneyman
Copy link
Contributor

If you have docs you’d like to add definitely feel free to add them as part of this update. If you would rather wait, open an issue, and open a pr later as a follow up that’s also perfectly fine. Just let me know what you’re thinking so I don’t merge prematurely!

@JordanMartinez
Copy link
Contributor Author

Hm... In that case, let's just merge this PR and I'll add that later.

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.

None yet

2 participants