mirror of
https://github.com/lovell/sharp.git
synced 2025-07-09 10:30:15 +02:00
99 lines
3.6 KiB
Markdown
99 lines
3.6 KiB
Markdown
# Contributing to sharp
|
|
|
|
Hello, thank you for your interest in helping!
|
|
|
|
## Submit a new bug report
|
|
|
|
Please create a [new issue](https://github.com/lovell/sharp/issues/new) containing the steps to reproduce the problem.
|
|
|
|
If you're having installation problems, please include the output of running `npm install --verbose sharp`.
|
|
|
|
New bugs are assigned a `triage` label whilst under investigation.
|
|
|
|
## Submit a new feature request
|
|
|
|
If a [similar request](https://github.com/lovell/sharp/labels/enhancement) exists,
|
|
it's probably fastest to add a comment to it about your requirement.
|
|
|
|
Implementation is usually straightforward if libvips
|
|
[already supports](https://www.libvips.org/API/current/func-list.html)
|
|
the feature you need.
|
|
|
|
## Submit a Pull Request to fix a bug
|
|
|
|
Thank you! To prevent the problem occurring again, please add unit tests that would have failed.
|
|
|
|
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/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/main/test/unit) to cover your new feature.
|
|
A test coverage report for the JavaScript code is generated in the `coverage/lcov-report` directory.
|
|
Please also update the [TypeScript definitions](https://github.com/lovell/sharp/tree/main/lib/index.d.ts), along with the [type definition tests](https://github.com/lovell/sharp/tree/main/test/types/sharp.test-d.ts).
|
|
|
|
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/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.
|
|
|
|
Please squash your changes into a single commit using a command like `git rebase -i upstream/<wip-branch>`.
|
|
|
|
### Add a new public method
|
|
|
|
The API tries to be as fluent as possible.
|
|
Image processing concepts follow the naming conventions from libvips and, to a lesser extent, ImageMagick.
|
|
|
|
Most methods have optional parameters and assume sensible defaults.
|
|
Please ensure backwards compatibility where possible.
|
|
|
|
Feel free to create a [new issue](https://github.com/lovell/sharp/issues/new) to gather feedback on a potential API change.
|
|
|
|
### Remove an existing public method
|
|
|
|
A method to be removed should be deprecated in the next major version then removed in the following major version.
|
|
|
|
By way of example, the `background()` method present in v0.20.0 was deprecated in v0.21.0 and removed in v0.22.0.
|
|
|
|
## Documentation
|
|
|
|
The public API is documented with [JSDoc](https://jsdoc.app/) annotated comments.
|
|
|
|
These can be converted to Markdown by running:
|
|
```sh
|
|
npm run docs-build
|
|
```
|
|
|
|
Please include documentation updates in any Pull Request that modifies the public API.
|
|
|
|
## Run the tests
|
|
|
|
### Functional tests and static code analysis
|
|
|
|
```sh
|
|
npm test
|
|
```
|
|
|
|
### Memory leak tests
|
|
|
|
Requires [Valgrind](http://valgrind.org/).
|
|
|
|
```sh
|
|
npm run test-leak
|
|
```
|
|
|
|
## Finally
|
|
|
|
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/main/package.json#L5)
|
|
for private, paid consulting.
|