Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
50 lines (38 loc) · 2.6 KB

CONTRIBUTING.md

File metadata and controls

50 lines (38 loc) · 2.6 KB

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.

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 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