From ff5fba339505600f473fa48039b39f72134f4a59 Mon Sep 17 00:00:00 2001 From: Nikita Almanov <131481562+nikkeyl@users.noreply.github.com> Date: Fri, 9 Feb 2024 19:31:41 +0300 Subject: [PATCH] docs: small changes --- .ecrc | 1 - .github/PULL_REQUEST_TEMPLATE.md | 6 ++---- CONTRIBUTING.md | 8 ++++---- 3 files changed, 6 insertions(+), 9 deletions(-) diff --git a/.ecrc b/.ecrc index b7bb354..385ebc0 100644 --- a/.ecrc +++ b/.ecrc @@ -3,7 +3,6 @@ "CHANGELOG.md", "config.yml", "CONTRIBUTING.md", - "PULL_REQUEST_TEMPLATE.md", "README.md" ] } diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md index 308b55a..436b454 100644 --- a/.github/PULL_REQUEST_TEMPLATE.md +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -8,7 +8,7 @@ Please, go through these steps before you submit a **Pull Request**. - You have done your changes in a separate branch. Branches MUST have descriptive names that start with either: - **`fix/`**, **`feature/`** or **`refactor`** prefixes. + **`fix/`**, **`feature/`** or **`refactor/`** prefixes. > Example: > @@ -28,8 +28,6 @@ Please, go through these steps before you submit a **Pull Request**. - Put **`closes #XXXX`** in your comment to auto-close the Issue that your **Pull Request** fixes (if such). -IMPORTANT: Please see our -[**Contribution Guidelines**](https://github.com/Archoleat/stylelint-config-extended-scss/blob/main/CONTRIBUTING.md) -for details. +IMPORTANT: Please see our **Contribution Guidelines** for details. **PLEASE REMOVE THIS TEMPLATE BEFORE SUBMITTING** diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index e59f6f9..b928886 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -30,13 +30,13 @@ for all involved. The community looks forward to your contributions. ## Code of Conduct This project and everyone participating in it is governed by the -[**Archoleat Stylelint Config Extended SCSS Code of Conduct**](https://github.com/Archoleat/stylelint-config-extended-scss/blob/main/CODE_OF_CONDUCT.md). +[**Archoleat Stylelint Config Extended SCSS Code of Conduct**](CODE_OF_CONDUCT.md). By participating, you are expected to uphold this code. ## I Have a Question > If you want to ask a question, we assume that you have read -> the available [**Documentation**](https://github.com/Archoleat/stylelint-config-extended-scss/blob/main/README.md). +> the available [**Documentation**](README.md). Before you ask a question, it is best to search for existing [**Issues**](https://github.com/Archoleat/stylelint-config-extended-scss/issues) @@ -79,7 +79,7 @@ potential bug as fast as possible. - Determine if your bug is really a bug and not an error on your side e.g. using incompatible environment components/versions - (Make sure that you have read the [**Documentation**](https://github.com/Archoleat/stylelint-config-extended-scss/blob/main/README.md). + (Make sure that you have read the [**Documentation**](README.md). If you are looking for support, you might want to check [**this section**](#i-have-a-question)). @@ -159,7 +159,7 @@ to understand your suggestion and find related suggestions. - Make sure that you are using the latest version. -- Read the [**Documentation**](https://github.com/Archoleat/stylelint-config-extended-scss/blob/main/README.md) +- Read the [**Documentation**](README.md) carefully and find out if the functionality is already covered, maybe by an individual configuration.