Skip to content

Latest commit

 

History

History
89 lines (56 loc) · 3.39 KB

CONTRIBUTING.md

File metadata and controls

89 lines (56 loc) · 3.39 KB
Raw

Contributing to Clover IIIF

Questions

If you have questions about Clover IIIF, be sure to check out the docs where we have several examples and detailed API references that may help you solve your problem.

How to contribute

There are many ways to contribute to the project. Code is just one possible means of contribution.

  • Feedback. Tell us what we're doing well or where we can improve.
  • Support. Please reach out to @mat or @adam.arling in the IIIF Slack workspace or submit a new issue in open issues.
  • Write. If you come up with an interesting example, write about it. Post it to your blog and share it with us. We'd love to see what folks in the community build with Clover IIIF!
  • Report. Create issues with bug reports so we can make Clover IIIF even better.

Working on your first Pull Request?

There are a lot of great resources on creating a good pull request. We've included a few below, but don't be shy—we appreciate all contriibutions and are happy to help those who are willing to help us!

Preparing a Pull Request

Pull Requests are always welcome, but before working on a large change, it is best to open an issue first to discuss it with maintainers.

A good PR is small, focuses on a single feature or improvement, and clearly communicates the problem it solves. Try not to include more than one issue in a single PR. It's much easier for us to review multiple small pull requests than one that is large and unwieldy.

  1. Fork the repository.

  2. Clone the fork to your local machine and add upstream remote:

git clone https://github.com/<your username>/clover-iiif.git
cd clover-iiif
git remote add upstream https://github.com/samvera-labs/clover-iiif.git
  1. Synchronize your local main branch with the upstream remote:
git checkout main
git pull upstream main
  1. Make sure your Node version matches the .nvmrc.
node -v
  1. Install dependencies with yarn:
npm run install
  1. Create a new branch related to your PR:
git checkout -b my-bug-fix
  1. Make changes, then commit and push to your forked repository:
git push -u origin HEAD

  1. Go to the repository and make a Pull Request.

  2. We will review your Pull Request and either merge it, request changes to it, or close it with an explanation.

Working locally

The repo is managed with Yarn Workspaces.

Development

# install dependencies
npm run install

# start Nextra-based docs and see examples in the browser
npm run dev

Make your changes and check that they resolve the problem with an example in the docs. We also suggest adding tests to support your change, and then run npm run test to make sure nothing is broken.

Lastly, run npm run build to ensure that the build runs successfully before submitting the pull request.