Skip to content

Improve CONTRIBUTING.md #691

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

Open
ExplodingCabbage wants to merge 2 commits into
base: master
Choose a base branch
from
+13 −1
Open

Improve CONTRIBUTING.md #691

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
74f624c
Improve CONTRIBUTING.md
ExplodingCabbage May 26, 2026
ef001d0
Slim it down
ExplodingCabbage May 26, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 13 additions & 1 deletion CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,3 +1,15 @@
# Contributing

jsdiff was originally written by Kevin Decker (https://github.com/kpdecker) but is presently maintained by Mark Amery (https://github.com/ExplodingCabbage) (henceforth "I").

Please post bug reports and feature requests at https://github.com/kpdecker/jsdiff/issues.

In particular, also feel free to post bugs that could amount to denial-of-service vulnerabilities as public issues. jsdiff has had a handful of such vulnerabilities in the past, often caused by bugs where some function has bad time complexity on adversarial input. I have never heard of them being exploited in the wild and do not consider their security implications particularly serious - so please just chuck them on the public issue tracker rather than disclosing privately. (All that notwithstanding, I will still try to fix them promptly when reported.)

In the extremely unlikely scenario that you find something more serious than a denial-of-service vulnerability (though I can't even imagine what this would be), please *do* keep it private and reach out to me and Kevin via the email addresses listed in `package.json`.

PRs are welcome (https://github.com/kpdecker/jsdiff/pulls). PRs with tests are even welcomer. I often reject them if I decide I prefer a slightly different approach, though, so the chance of wasting work is high.

## Building and testing

```
Expand All @@ -10,7 +22,7 @@ To run tests in a *browser* (for instance to test compatibility with Firefox, wi
If you notice any problems, please report them to the GitHub issue tracker at
[http://github.com/kpdecker/jsdiff/issues](http://github.com/kpdecker/jsdiff/issues).

## Releasing
## Releasing (maintainers only)

Run a test in Firefox via the procedure above before releasing.

Expand Down