CONTRIBUTING.md

Contributing to @extractus/article-extractor

Glad to see you here.

Collaborations and pull requests are always welcomed, though larger proposals should be discussed first.

As an OSS, it's better to follow the Unix philosophy: "do one thing and do it well".

Third-party libraries

Please avoid using libaries other than those available in the standard library, unless necessary.

This library needs to be simple and flexible to run on multiple platforms such as Deno, Bun, or even browser.

Coding convention

Make sure your code lints before opening a pull request.

cd article-extractor

# check coding convention issue
npm run lint

# auto fix coding convention issue
npm run lint:fix

When you run npm test, the linting process will be triggered at first.

Testing

Be sure to run the unit test suite before opening a pull request. An example test run is shown below.

cd article-extractor
npm test

If test coverage decreased, please check test scripts and try to improve this number.

Documentation

If you've changed APIs, please update README and the examples.

Clean commit histories

When you open a pull request, please ensure the commit history is clean. Squash the commits into logical blocks, perhaps a single commit if that makes sense.

What you want to avoid is commits such as "WIP" and "fix test" in the history. This is so we keep history on master clean and straightforward.

For people new to git, please refer the following guides:

• Writing good commit messages
• Commit Message Guidelines

License

By contributing to @extractus/article-extractor, you agree that your contributions will be licensed under its MIT license.

---