mirror of
https://github.com/sharkdp/fd.git
synced 2024-11-16 08:58:26 +01:00
08c0d427bf
Summary: Currently, `--ignore-vcs` only serves to unset `--no-ignore-vcs`. There is currently no way to tell fd to respect gitignore files when not in a git repository. This commit adds the flag `--no-require-git` to make fd always respect all gitignore files. This behaves the same as the `--no-require-git` option in [ripgrep](3bb71b0cb8/crates/core/app.rs (L2214-L2226)) This commit also contains an unrelated wording fix to CONTRIBUTING.md Test Plan: `tests/tests.rs` Background: I am using [Sapling](https://sapling-scm.com/docs/introduction/) for working with git repositories (including this commit ☺️). Since Sapling uses `.sl` instead of `.git`, tools using the `ignore` crate (rg and fd) would show gitignored files. I made a patch (ebf17eef22) to `ignore` to respect gitignores with _either_ `.git` or `.sl`. However, @BurntSushi said he did not want to merge that patch and instead suggested I use `--no-require-git` (https://github.com/BurntSushi/ripgrep/issues/2374). This works fine, but I couldn't use this workaround for my other favorite tool! That's what this patch is for 😁 (a follow-up patch will add a similar `FD_CONFIG_PATH` environment variable like `RG_CONFIG_PATH`)
37 lines
1.6 KiB
Markdown
37 lines
1.6 KiB
Markdown
## Contributing to *fd*
|
|
|
|
**Thank you very much for considering to contribute 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.
|
|
|
|
## 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)
|