mirror of
https://github.com/sharkdp/fd.git
synced 2026-08-28 18:20:32 +08:00
Thayne McCombs
55 lines
3.0 KiB
Markdown
55 lines
3.0 KiB
Markdown
## Contributing to *fd*
|
|
|
|
**Thank you very much for considering contributing to this project!**
|
|
|
|
We welcome any form of contribution:
|
|
|
|
* New issues (feature requests, bug reports, questions, ideas, ...)
|
|
* Pull requests (documentation improvements, code improvements, new features, ...)
|
|
|
|
**Note**: Before you take the time to open a pull request, please open a ticket first. This will
|
|
give us the chance to discuss any potential changes first.
|
|
|
|
## Pull Request Expectations
|
|
|
|
1. Your contribution should be high quality, and best effort. In particular, please don't make a Pull Request
|
|
that was created using generative AI unless you have reviewed it yourself and understand what it does, and be
|
|
able to meaningfully answer questions and make changes to it as needed.
|
|
2. Your code should successfully compile and pass tests before publishing a Pull Request. It's understandable
|
|
if tests fail on one or two specific targets, but if the build doesn't pass for any targets, that is a signal
|
|
that the PR is low effort.
|
|
3. It is your responsibility to ensure that the generated code does not violate any copyrights or patents. This is
|
|
true of all contributions, but is especially relevant when using an LLM that may be generating output that is
|
|
very similar or even identical to existing code with an incompatible license.
|
|
4. If an AI coding assistant or other LLM tool was used, you must indicate that an AI tool was used, and to what extent it was used.
|
|
5. AI should not be used to generate comments when communicating with maintainers. We expect communication with the maintainers,
|
|
including PR descriptions and comments, to be from humans, not from an AI. Using an AI to assist with grammar, spelling, and
|
|
proofreading or translating is acceptable, as long as the content and voice of the
|
|
message is your own.
|
|
|
|
## Add an entry to the changelog
|
|
|
|
If your contribution changes the behavior of `fd` (as opposed to a typo-fix
|
|
in the documentation), please update the [`CHANGELOG.md`](CHANGELOG.md#upcoming-release) file
|
|
and describe your changes. This makes the release process much easier and
|
|
therefore helps to get your changes into a new `fd` release faster.
|
|
|
|
The top of the `CHANGELOG` contains an *"Upcoming release"* section with a few
|
|
subsections (Features, Bugfixes, …). Please add your entry to the subsection
|
|
that best describes your change.
|
|
|
|
Entries follow this format:
|
|
```
|
|
- Short description of what has been changed, see #123 (@user)
|
|
```
|
|
Here, `#123` is the number of the original issue and/or your pull request.
|
|
Please replace `@user` by your GitHub username.
|
|
|
|
## Important links
|
|
|
|
* [Open issues](https://github.com/sharkdp/fd/issues)
|
|
* [Open pull requests](https://github.com/sharkdp/fd/pulls)
|
|
* [Development section in the README](https://github.com/sharkdp/fd#development)
|
|
* [fd on crates.io](https://crates.io/crates/fd-find)
|
|
* [LICENSE-APACHE](https://github.com/sharkdp/fd/blob/master/LICENSE-APACHE) and [LICENSE-MIT](https://github.com/sharkdp/fd/blob/master/LICENSE-MIT)
|