From 46cf29ed6da51652e079a28f1d0ca386b379da15 Mon Sep 17 00:00:00 2001 From: Kanad Gupta Date: Wed, 13 Jul 2022 10:59:18 -0500 Subject: [PATCH] docs: remove duplicated commit conventions --- CONTRIBUTING.md | 25 +------------------------ 1 file changed, 1 insertion(+), 24 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index c98e8bf94..8ccffc68c 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -71,27 +71,4 @@ When writing command logic, avoid using `console` statements (and correspondingl ### Commit Conventions -When pushing or merging PRs in to `main`, your commit messages should follow the [Angular commit conventions](https://github.com/angular/angular.js/blob/master/DEVELOPERS.md#-git-commit-guidelines). At it's simplest, this looks something like `{type}: change this, add that`, where the commit `{type}` can be one of the following: - -| Commit Type | Description | -| :---------- | :--------------------------------------- | -| `build` | creating a new release | -| `chore` | assorted minor changes | -| `ci` | updates related to the ci process | -| `docs` | documentation updates | -| `feat` | new elements; major features and updates | -| `fix` | bug fixes; security updates | -| `perf` | performance improvements | -| `refactor` | general refactors | -| `revert` | reverting a previous commit | -| `style` | aesthetic changes | -| `test` | adding or updating existing tests | - -You can also optionally note the `{scope}` of your changes in an additional parenthetical. If your changes require a longer description, feel free to add a commit message with further details! Combining all of these together, you might end up with something like: - -```text -feat(auth): add support for cookie auth - -- some more details -- about the changes -``` +For our general commit conventions, please consult our organization contributing guidelines [here](https://github.com/readmeio/.github/blob/main/.github/CONTRIBUTING.md#commit-conventions).