diff options
author | Tavian Barnes <tavianator@tavianator.com> | 2023-12-16 12:47:45 -0500 |
---|---|---|
committer | Tavian Barnes <tavianator@tavianator.com> | 2023-12-16 12:48:38 -0500 |
commit | fd91097055f095fdd827ef8751d9534f59a89404 (patch) | |
tree | 39db52d99b17b746f905dd28c5dbde7437c95501 | |
parent | aa8344e04bfe950cc9f5e45352cd8202295e0cdf (diff) | |
download | bfs-fd91097055f095fdd827ef8751d9534f59a89404.tar.xz |
docs: Rename HACKING to CONTRIBUTING
So that GitHub recognizes it.
-rw-r--r-- | README.md | 4 | ||||
-rw-r--r-- | docs/CONTRIBUTING.md (renamed from docs/HACKING.md) | 4 | ||||
-rw-r--r-- | docs/USAGE.md | 8 |
3 files changed, 8 insertions, 8 deletions
@@ -9,13 +9,13 @@ <a href="https://codecov.io/gh/tavianator/bfs"><img src="https://img.shields.io/codecov/c/github/tavianator/bfs?token=PpBVuozOVC" alt="Code coverage" align="right"/></a> </h1> -**[Features] • [Installation] • [Usage] • [Building] • [Hacking] • [Changelog]** +**[Features] • [Installation] • [Usage] • [Building] • [Contributing] • [Changelog]** [Features]: #features [Installation]: #installation [Usage]: /docs/USAGE.md [Building]: /docs/BUILDING.md -[Hacking]: /docs/HACKING.md +[Contributing]: /docs/CONTRIBUTING.md [Changelog]: /docs/CHANGELOG.md <picture> diff --git a/docs/HACKING.md b/docs/CONTRIBUTING.md index 0763fda..099157d 100644 --- a/docs/HACKING.md +++ b/docs/CONTRIBUTING.md @@ -1,5 +1,5 @@ -Hacking on `bfs` -================ +Contributing to `bfs` +===================== License ------- diff --git a/docs/USAGE.md b/docs/USAGE.md index 86eef87..3efdee0 100644 --- a/docs/USAGE.md +++ b/docs/USAGE.md @@ -18,7 +18,7 @@ $ bfs ./completions/bfs.zsh ./docs/BUILDING.md ./docs/CHANGELOG.md -./docs/HACKING.md +./docs/CONTRIBUTING.md ./docs/USAGE.md ./docs/bfs.1 ... @@ -53,7 +53,7 @@ $ bfs -name '*.md' ./README.md ./docs/BUILDING.md ./docs/CHANGELOG.md -./docs/HACKING.md +./docs/CONTRIBUTING.md ./docs/USAGE.md ``` @@ -64,7 +64,7 @@ When you put multiple expressions next to each other, both of them must match: ```console $ bfs -name '*.md' -name '*ING*' ./docs/BUILDING.md -./docs/HACKING.md +./docs/CONTRIBUTING.md ``` This works because the expressions are implicitly combined with *logical and*. @@ -84,7 +84,7 @@ $ bfs -name '*.md' -or -name 'bfs.*' ./completions/bfs.zsh ./docs/BUILDING.md ./docs/CHANGELOG.md -./docs/HACKING.md +./docs/CONTRIBUTING.md ./docs/USAGE.md ./docs/bfs.1 ``` |