Contributions to slimsearch
are welcome :) Just follow the guidelines below.
If you have an idea for a feature, or spotted a bug, please open an issue on GitHub.
Check if your issue was already reported. In that case, better to comment on the existing issue rather than open a duplicate one.
When reporting a bug, whenever possible, provide some example code to reproduce the bug: that will make the process of fixing it much faster.
Remember this is an open-source project. Your feature requests will be discussed and taken into consideration, but please do not take it personally if the feature does not get implemented. This project uses a permissive license, so pull requests are welcome and forks are permitted.
Always be respectful of others when discussing issues. The project maintainer has the right and responsibility to remove or close discussions where the tone or language is derogatory, harassing, or offensive toward others. Keep the Code of Conduct in mind.
Thinking about sending a pull request? That is great :) Here is how you can setup your development environment:
Clone the repository
Install the development dependencies with pnpm install
Run the tests with pnpm test
.
If you are working on optimizing the performance, you can run the
performance benchmarks with pnpm benchmark
If you are improving the documentation, you can build the docs with yarn build-docs
In order to understand implementation details and design goals, read the design document.
Also, please follow these guidelines:
Add tests for your code. This ensures that your feature won't be broken by further code changes. If you are not sure how to test, feel free to send the pull request and ask for advices in the comment.
Don't change the version number. That will be done by the maintainer upon releasing a new version.
Make sure that the full test suite passes before sending the pull request.
Try to follow the project's code conventions and style when possible. You
can run pnpm lint
to check if your code follows the project style, and
linting errors can often be fixed automatically by running pnpm link --fix
.
此处可能存在不合适展示的内容,页面不予展示。您可通过相关编辑功能自查并修改。
如您确认内容无涉及 不当用语 / 纯广告导流 / 暴力 / 低俗色情 / 侵权 / 盗版 / 虚假 / 无价值内容或违法国家有关法律法规的内容,可点击提交进行申诉,我们将尽快为您处理。