From a293fa208d56fd87b388009d47c4de16af1beaeb Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Christina=20S=C3=B8rensen?= Date: Mon, 11 Sep 2023 17:58:46 +0200 Subject: [PATCH] docs(contributing): add pthorpe92 gist MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Signed-off-by: Christina Sørensen --- CONTRIBUTING.md | 27 ++++++++++++++++++++++++++- 1 file changed, 26 insertions(+), 1 deletion(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index bb8dd3cb..c835e3e8 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -1,5 +1,4 @@ # Contributing -This document is heavily WIP. If you wanna contribute to `eza`, here are the absolute basics: - your commit summary should follow conventional commits. @@ -58,3 +57,29 @@ option just like the normal grid view. Resolves #129 ``` + +### Additional Examples + +- feat: add column selection +- fix(output): fix width issue with columns +- test(fs): add tests for filesystem metadata +- feat!: breaking change / feat(config)!: implement config file +- chore(deps): update dependencies + +### Commit types + +- build: Changes that affect the build system or external dependencies (example libgit2) +- ci: Changes to CI configuration files and scripts (example scopes: Nix, Vagrant, Docker) +- chore: Changes which do not change source code or tests (example: changes to the build process, auxiliary tools, libraries) +- docs: Documentation, README, completions, manpage only +- feat: A new feature +- fix: A bug fix +- perf: A code change that improves or addresses a performance issue +- refactor: A code change that neither fixes a bug nor adds a feature +- revert: Revert something +- style: Changes that do not affect the meaning of the code (example: clippy) +- test: Adding missing tests or correcting existing tests + +### Reminders +Put newline before extended commit body +More details at conventionalcommits.org