diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml index e0055da..2833326 100644 --- a/.github/ISSUE_TEMPLATE/config.yml +++ b/.github/ISSUE_TEMPLATE/config.yml @@ -1,5 +1,5 @@ blank_issues_enabled: false contact_links: - name: Get Help in GitHub Discussions - url: https://github.com/Conqueror-Site-Builder/stylelint-conqueror-config-scss/discussions + url: https://github.com/Conqueror-Site-Builder/stylelint-config-conqueror-scss/discussions about: Have a question? Not sure if your issue affects everyone reproducibly? diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md index 958645c..765e05e 100644 --- a/.github/PULL_REQUEST_TEMPLATE.md +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -29,7 +29,7 @@ Please, go through these steps before you submit a **Pull Request**. the Issue that your **Pull Request** fixes (if such). IMPORTANT: Please see our -[**Contribution Guidelines**](https://github.com/Conqueror-Site-Builder/stylelint-conqueror-config-scss/blob/main/CONTRIBUTING.md) +[**Contribution Guidelines**](https://github.com/Conqueror-Site-Builder/stylelint-config-conqueror-scss/blob/main/CONTRIBUTING.md) for details. **PLEASE REMOVE THIS TEMPLATE BEFORE SUBMITTING** diff --git a/.github/config.yml b/.github/config.yml index 344753a..99301b0 100644 --- a/.github/config.yml +++ b/.github/config.yml @@ -3,7 +3,7 @@ newIssueWelcomeComment: > newPRWelcomeComment: > Thanks for opening this Pull Request! - Please check out our [Contributing Guidelines](https://github.com/Conqueror-Site-Builder/stylelint-conqueror-config-scss/blob/main/CONTRIBUTING.md). + Please check out our [Contributing Guidelines](https://github.com/Conqueror-Site-Builder/stylelint-config-conqueror-scss/blob/main/CONTRIBUTING.md). firstPRMergeComment: > Congrats on merging your first Pull Request! diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index d8e507c..43879cb 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -30,16 +30,16 @@ for all involved. The community looks forward to your contributions. ## Code of Conduct This project and everyone participating in it is governed by the -[**Stylelint Conqueror Config SCSS Code of Conduct**](https://github.com/Conqueror-Site-Builder/stylelint-conqueror-config-scss/blob/main/CODE_OF_CONDUCT.md). +[**Stylelint Config Conqueror SCSS Code of Conduct**](https://github.com/Conqueror-Site-Builder/stylelint-config-conqueror-scss/blob/main/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/Conqueror-Site-Builder/stylelint-conqueror-config-scss/blob/main/README.md). +> the available [**Documentation**](https://github.com/Conqueror-Site-Builder/stylelint-config-conqueror-scss/blob/main/README.md). Before you ask a question, it is best to search for existing -[**Issues**](https://github.com/Conqueror-Site-Builder/stylelint-conqueror-config-scss/issues) +[**Issues**](https://github.com/Conqueror-Site-Builder/stylelint-config-conqueror-scss/issues) that might help you. In case you have found a suitable **Issue** and still need clarification, you can write your question in this **Issue**. It is also advisable to search the internet for answers first. @@ -48,7 +48,7 @@ If you then still feel the need to ask a question and need clarification, we recommend the following: - Open an - [**Issue**](https://github.com/Conqueror-Site-Builder/stylelint-conqueror-config-scss/issues/new/choose). + [**Issue**](https://github.com/Conqueror-Site-Builder/stylelint-config-conqueror-scss/issues/new/choose). - Provide as much context as you can about what you're running into. @@ -79,14 +79,14 @@ 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/Conqueror-Site-Builder/stylelint-conqueror-config-scss/blob/main/README.md). + (Make sure that you have read the [**Documentation**](https://github.com/Conqueror-Site-Builder/stylelint-config-conqueror-scss/blob/main/README.md). If you are looking for support, you might want to check [**this section**](#i-have-a-question)). - To see if other users have experienced (and potentially already solved) the same **Issue** you are having, check if there is not already a bug report existing for your bug or error in the - [**bug tracker**](https://github.com/Conqueror-Site-Builder/stylelint-conqueror-config-scss/issues?q=label%3Abug). + [**bug tracker**](https://github.com/Conqueror-Site-Builder/stylelint-config-conqueror-scss/issues?q=label%3Abug). - Also make sure to search the internet (including **Stack Overflow**) to see if users outside of the **GitHub community** have discussed @@ -118,7 +118,7 @@ We use GitHub **Issues** to track bugs and errors. If you run into an **Issue** with the project: - Open an - [**Issue**](https://github.com/Conqueror-Site-Builder/stylelint-conqueror-config-scss/issues/new/choose). + [**Issue**](https://github.com/Conqueror-Site-Builder/stylelint-config-conqueror-scss/issues/new/choose). (Since we can't be sure at this point whether it is a bug or not, we ask you not to talk about a bug yet and not to label the **Issue**.) @@ -150,7 +150,7 @@ Once it's filed: ### Suggesting Enhancements This section guides you through submitting an enhancement suggestion for -**Stylelint Conqueror Config SCSS**, **including completely new features +**Stylelint Config Conqueror SCSS**, **including completely new features and minor improvements to existing functionality**. Following these guidelines will help maintainers and the community to understand your suggestion and find related suggestions. @@ -159,12 +159,12 @@ to understand your suggestion and find related suggestions. - Make sure that you are using the latest version. -- Read the [**Documentation**](https://github.com/Conqueror-Site-Builder/stylelint-conqueror-config-scss/blob/main/README.md) +- Read the [**Documentation**](https://github.com/Conqueror-Site-Builder/stylelint-config-conqueror-scss/blob/main/README.md) carefully and find out if the functionality is already covered, maybe by an individual configuration. - Perform a - [**search**](https://github.com/Conqueror-Site-Builder/stylelint-conqueror-config-scss/issues) + [**search**](https://github.com/Conqueror-Site-Builder/stylelint-config-conqueror-scss/issues) to see if the enhancement has already been suggested. If it has, add a comment to the existing **Issue** instead of opening a new one. @@ -178,7 +178,7 @@ to understand your suggestion and find related suggestions. #### How Do I Submit a Good Enhancement Suggestion? -Enhancement suggestions are tracked as [**GitHub Issues**](https://github.com/Conqueror-Site-Builder/stylelint-conqueror-config-scss/issues/new/choose). +Enhancement suggestions are tracked as [**GitHub Issues**](https://github.com/Conqueror-Site-Builder/stylelint-config-conqueror-scss/issues/new/choose). - Use a **clear and descriptive title** for the **Issue** to identify the suggestion. @@ -187,13 +187,13 @@ Enhancement suggestions are tracked as [**GitHub Issues**](https://github.com/Co in as many details as possible. - **Explain why this enhancement would be useful** to most - **Stylelint Conqueror Config SCSS** users. You may also want to point + **Stylelint Config Conqueror SCSS** users. You may also want to point out the other projects that solved it better and which could serve as inspiration. ### Improving The Documentation -Enhancing the documentation of **Stylelint Conqueror Config SCSS** is +Enhancing the documentation of **Stylelint Config Conqueror SCSS** is crucial for ensuring its usability and accessibility to a wider audience. Comprehensive and well-structured documentation empowers users to effectively leverage the template's features and effectively @@ -216,10 +216,10 @@ build their projects. #### How to Submit Documentation Enhancements -Enhancement suggestions are tracked as [**GitHub Issues**](https://github.com/Conqueror-Site-Builder/stylelint-conqueror-config-scss/issues/new/choose). +Enhancement suggestions are tracked as [**GitHub Issues**](https://github.com/Conqueror-Site-Builder/stylelint-config-conqueror-scss/issues/new/choose). - Use a **clear and descriptive title** for the **Issue** to identify the suggestion. - **Explain why this enhancement would be useful** to most - **Stylelint Conqueror Config SCSS** users. + **Stylelint Config Conqueror SCSS** users. diff --git a/README.md b/README.md index 311ae3a..f1a54a4 100644 --- a/README.md +++ b/README.md @@ -1,12 +1,12 @@ # Stylelint Conqueror Config SCSS ![ESM Only](https://img.shields.io/badge/ESM-only-gray?labelColor=fe0) -![CodeQL](https://img.shields.io/github/actions/workflow/status/Conqueror-Site-Builder/stylelint-conqueror-config-scss/codeql.yml?label=CodeQL) -![Test](https://img.shields.io/github/actions/workflow/status/Conqueror-Site-Builder/stylelint-conqueror-config-scss/mocha.yml?label=Test) -![Editorconfig](https://img.shields.io/github/actions/workflow/status/Conqueror-Site-Builder/stylelint-conqueror-config-scss/editorconfig.yml?label=Editorconfig) -![Prettier](https://img.shields.io/github/actions/workflow/status/Conqueror-Site-Builder/stylelint-conqueror-config-scss/prettier.yml?label=Prettier) -![Markdown](https://img.shields.io/github/actions/workflow/status/Conqueror-Site-Builder/stylelint-conqueror-config-scss/markdown.yml?label=Markdown) -![ESLint](https://img.shields.io/github/actions/workflow/status/Conqueror-Site-Builder/stylelint-conqueror-config-scss/eslint.yml?label=ESLint) +![CodeQL](https://img.shields.io/github/actions/workflow/status/Conqueror-Site-Builder/stylelint-config-conqueror-scss/codeql.yml?label=CodeQL) +![Test](https://img.shields.io/github/actions/workflow/status/Conqueror-Site-Builder/stylelint-config-conqueror-scss/mocha.yml?label=Test) +![Editorconfig](https://img.shields.io/github/actions/workflow/status/Conqueror-Site-Builder/stylelint-config-conqueror-scss/editorconfig.yml?label=Editorconfig) +![Prettier](https://img.shields.io/github/actions/workflow/status/Conqueror-Site-Builder/stylelint-config-conqueror-scss/prettier.yml?label=Prettier) +![Markdown](https://img.shields.io/github/actions/workflow/status/Conqueror-Site-Builder/stylelint-config-conqueror-scss/markdown.yml?label=Markdown) +![ESLint](https://img.shields.io/github/actions/workflow/status/Conqueror-Site-Builder/stylelint-config-conqueror-scss/eslint.yml?label=ESLint) ## Table of Contents @@ -52,33 +52,33 @@ - **`lint:formatting`**: Runs **Prettier** with the **`--check`** flag for all files. - > In the [**`prettier.yml`**](https://github.com/Conqueror-Site-Builder/stylelint-conqueror-config-scss/blob/main/.github/workflows/prettier.yml) + > In the [**`prettier.yml`**](https://github.com/Conqueror-Site-Builder/stylelint-config-conqueror-scss/blob/main/.github/workflows/prettier.yml) > > Also run with a **`pre-commit`** hook. - **`lint:editorconfig`**: Runs **Editorconfig Checker** and checks all files in the project. - > Also runs with the [**`editorconfig.yml`**](https://github.com/Conqueror-Site-Builder/stylelint-conqueror-config-scss/blob/main/.github/workflows/editorconfig.yml) + > Also runs with the [**`editorconfig.yml`**](https://github.com/Conqueror-Site-Builder/stylelint-config-conqueror-scss/blob/main/.github/workflows/editorconfig.yml) > workflow. - **`lint:md`**: Runs **Remark** with the **`--quiet`** flag and checks all **markdown** files. - > Also runs with the [**`markdown.yml`**](https://github.com/Conqueror-Site-Builder/stylelint-conqueror-config-scss/blob/main/.github/workflows/markdown.yml) + > Also runs with the [**`markdown.yml`**](https://github.com/Conqueror-Site-Builder/stylelint-config-conqueror-scss/blob/main/.github/workflows/markdown.yml) > workflow. - **`lint:ts`**: Runs **ESLint** with the flag **`--fix`** for all **TypeScript** files. - > Runs with the [**`eslint.yml`**](https://github.com/Conqueror-Site-Builder/stylelint-conqueror-config-scss/blob/main/.github/workflows/eslint.yml) + > Runs with the [**`eslint.yml`**](https://github.com/Conqueror-Site-Builder/stylelint-config-conqueror-scss/blob/main/.github/workflows/eslint.yml) > workflow. > > Also run with a **`pre-commit`** hook. - **`test`**: Runs **Mocha** and the tests in the **specs/** folder. - > Also runs using the [**`mocha.yml`**](https://github.com/Conqueror-Site-Builder/stylelint-conqueror-config-scss/blob/main/.github/workflows/mocha.yml) + > Also runs using the [**`mocha.yml`**](https://github.com/Conqueror-Site-Builder/stylelint-config-conqueror-scss/blob/main/.github/workflows/mocha.yml) > workflow. - **`commit`**: Runs **Commitizen**, **Commitlint**, and **Husky** to @@ -117,7 +117,7 @@ See also the list of [**Authors**](AUTHORS.md). ## Contributors If you want to improve something, you can write about it -[**here**](https://github.com/Conqueror-Site-Builder/stylelint-conqueror-config-scss/issues/new/choose). +[**here**](https://github.com/Conqueror-Site-Builder/stylelint-config-conqueror-scss/issues/new/choose). You can also view a list of [**Contributors**](CONTRIBUTORS.md). @@ -131,7 +131,7 @@ and the process for submitting **Pull Request** to us. We use [**SemVer**](https://semver.org) for versioning. You can see the available versions -[**here**](https://github.com/Conqueror-Site-Builder/stylelint-conqueror-config-scss/tags). +[**here**](https://github.com/Conqueror-Site-Builder/stylelint-config-conqueror-scss/tags). ## License diff --git a/package.json b/package.json index ad1d5ce..4d57c4c 100644 --- a/package.json +++ b/package.json @@ -11,16 +11,16 @@ "test": "mocha", "commit": "cz" }, - "homepage": "https://github.com/Conqueror-Site-Builder/stylelint-conqueror-config-scss#readme", + "homepage": "https://github.com/Conqueror-Site-Builder/stylelint-config-conqueror-scss#readme", "repository": { "type": "git", - "url": "https://github.com/Conqueror-Site-Builder/stylelint-conqueror-config-scss.git" + "url": "https://github.com/Conqueror-Site-Builder/stylelint-config-conqueror-scss.git" }, "bugs": { - "url": "https://github.com/Conqueror-Site-Builder/stylelint-conqueror-config-scss/issues" + "url": "https://github.com/Conqueror-Site-Builder/stylelint-config-conqueror-scss/issues" }, "author": "Conqueror Site Builder", - "name": "stylelint-conqueror-config-scss", + "name": "stylelint-config-conqueror-scss", "description": "Extended config for Stylelint with property sorting", "version": "1.0.0", "license": "MIT",