diff --git a/.github/CONTRIBUTING.md b/.github/CONTRIBUTING.md index 0853a4adf..f80a68269 100644 --- a/.github/CONTRIBUTING.md +++ b/.github/CONTRIBUTING.md @@ -23,22 +23,22 @@ the feature you need. Thank you! To prevent the problem occurring again, please add unit tests that would have failed. -Please select the `master` branch as the destination for your Pull Request so your fix can be included in the next minor release. +Please select the `main` branch as the destination for your Pull Request so your fix can be included in the next minor release. -Please squash your changes into a single commit using a command like `git rebase -i upstream/master`. +Please squash your changes into a single commit using a command like `git rebase -i upstream/main`. To test C++ changes, you can compile the module using `npm install --build-from-source` and then run the tests using `npm test`. ## Submit a Pull Request with a new feature -Please add JavaScript [unit tests](https://github.com/lovell/sharp/tree/master/test/unit) to cover your new feature. +Please add JavaScript [unit tests](https://github.com/lovell/sharp/tree/main/test/unit) to cover your new feature. A test coverage report for the JavaScript code is generated in the `coverage/lcov-report` directory. Where possible, the functional tests use gradient-based perceptual hashes based on [dHash](http://www.hackerfactor.com/blog/index.php?/archives/529-Kind-of-Like-That.html) to compare expected vs actual images. -You deserve to add your details to the [list of contributors](https://github.com/lovell/sharp/blob/master/package.json#L5). +You deserve to add your details to the [list of contributors](https://github.com/lovell/sharp/blob/main/package.json#L5). Any change that modifies the existing public API should be added to the relevant work-in-progress branch for inclusion in the next major release. @@ -93,5 +93,5 @@ Please feel free to ask any questions via a [new issue](https://github.com/lovell/sharp/issues/new). If you're unable to post details publicly, please -[e-mail](https://github.com/lovell/sharp/blob/master/package.json#L5) +[e-mail](https://github.com/lovell/sharp/blob/main/package.json#L5) for private, paid consulting. diff --git a/.github/ISSUE_TEMPLATE/installation.md b/.github/ISSUE_TEMPLATE/installation.md index d052bda6b..313e9d2c7 100644 --- a/.github/ISSUE_TEMPLATE/installation.md +++ b/.github/ISSUE_TEMPLATE/installation.md @@ -5,6 +5,8 @@ labels: installation --- + + Did you see the [documentation relating to installation](https://sharp.pixelplumbing.com/install)? Have you ensured the architecture and platform of Node.js used for `npm install` is the same as the architecture and platform of Node.js used at runtime? diff --git a/README.md b/README.md index f42f90d85..d533acac9 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,6 @@ # sharp -sharp logo +sharp logo The typical use case for this high speed Node.js module is to convert large images in common formats to @@ -95,10 +95,10 @@ readableStream ## Contributing -A [guide for contributors](https://github.com/lovell/sharp/blob/master/.github/CONTRIBUTING.md) +A [guide for contributors](https://github.com/lovell/sharp/blob/main/.github/CONTRIBUTING.md) covers reporting bugs, requesting features and submitting code changes. -[![Test Coverage](https://coveralls.io/repos/lovell/sharp/badge.svg?branch=master)](https://coveralls.io/r/lovell/sharp?branch=master) +[![Test Coverage](https://coveralls.io/repos/lovell/sharp/badge.svg?branch=main)](https://coveralls.io/r/lovell/sharp?branch=main) [![Node-API v5](https://img.shields.io/badge/Node--API-v5-green.svg)](https://nodejs.org/dist/latest/docs/api/n-api.html#n_api_n_api_version_matrix) ## Licensing diff --git a/docs/README.md b/docs/README.md index efee04305..5a98fd81c 100644 --- a/docs/README.md +++ b/docs/README.md @@ -1,6 +1,6 @@ # sharp -sharp logo +sharp logo The typical use case for this high speed Node.js module is to convert large images in common formats to @@ -65,7 +65,7 @@ as [pngcrush](https://pmt.sourceforge.io/pngcrush/). ### Contributing -A [guide for contributors](https://github.com/lovell/sharp/blob/master/.github/CONTRIBUTING.md) +A [guide for contributors](https://github.com/lovell/sharp/blob/main/.github/CONTRIBUTING.md) covers reporting bugs, requesting features and submitting code changes. ### Licensing