From 4d05908e3b4db1571b0d18131ea8546b3c39e2df Mon Sep 17 00:00:00 2001 From: MicLieg <38057464+MicLieg@users.noreply.github.com> Date: Tue, 6 Aug 2024 16:35:53 +0200 Subject: [PATCH] Adjusted markdownlint to agree with prettier and fixed markdown errors --- .editorconfig | 2 +- .github/pull_request_template.md | 4 +- .markdownlint.json | 42 +++++++++++++++++---- CONTRIBUTING.md | 65 ++++++++++++++++---------------- README.md | 12 +++--- 5 files changed, 76 insertions(+), 49 deletions(-) diff --git a/.editorconfig b/.editorconfig index b431f6af67..1b6c04f2e5 100644 --- a/.editorconfig +++ b/.editorconfig @@ -30,4 +30,4 @@ indent_size = 4 # MARKDOWN Files [*.{md}] indent_style = space -indent_size = 4 \ No newline at end of file +indent_size = 4 diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md index 4e6d083273..8558c32184 100644 --- a/.github/pull_request_template.md +++ b/.github/pull_request_template.md @@ -29,7 +29,7 @@ PR will not be merged until all steps are complete. If documentation does need updating either update it by creating a PR (preferred) or request a documentation update. -- User docs: https://github.com/GameServerManagers/LinuxGSM-Docs -- Dev docs: https://github.com/GameServerManagers/LinuxGSM-Dev-Docs +- User docs: +- Dev docs: **Thank you for your Pull Request!** diff --git a/.markdownlint.json b/.markdownlint.json index d3f9e5f27f..33e2d3ddc8 100644 --- a/.markdownlint.json +++ b/.markdownlint.json @@ -1,9 +1,35 @@ { - "MD013": false, - "MD030": { - "ul_single": 3, - "ol_single": 1, - "ul_multi": 3, - "ol_multi": 1 - } - } + "no-duplicate-heading": false, + "no-inline-html": { + "allowed_elements": [ + "figure", + "figcaption", + "img", + "p" + ] + }, + "no-bare-urls": false, + "comment": "The following entries disable rules that may conflict with Prettier see https://github.com/DavidAnson/markdownlint/blob/v0.34.0/style/prettier.json", + "blanks-around-fences": false, + "blanks-around-headings": false, + "blanks-around-lists": false, + "code-fence-style": false, + "emphasis-style": false, + "heading-start-left": false, + "hr-style": false, + "line-length": false, + "list-indent": false, + "list-marker-space": false, + "no-blanks-blockquote": false, + "no-hard-tabs": false, + "no-missing-space-atx": false, + "no-missing-space-closed-atx": false, + "no-multiple-blanks": false, + "no-multiple-space-atx": false, + "no-multiple-space-blockquote": false, + "no-multiple-space-closed-atx": false, + "no-trailing-spaces": false, + "ol-prefix": false, + "strong-style": false, + "ul-indent": false +} \ No newline at end of file diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 7b549c795b..76fe2b8f12 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -8,31 +8,32 @@ The following is a set of guidelines for contributing to LinuxGSM, which are hos [Contributing to LinuxGSM](#contributing-to-linuxgsm) -- [Table of Contents](#table-of-contents) -- [Code of Conduct](#code-of-conduct) -- [🎉 Bug/Enhancement Contributions 🐛](#bug-enhancement-contributions) - - [🐛Reporting Bugs](#reporting-bugs) - - [Before Submitting A Bug Report](#before-submitting-a-bug-report) - - [How Do I Submit A (Good) Bug Report?](#how-do-i-submit-a--good--bug-report-) - - [🎉Suggesting Features](#suggesting-features) - - [Before Submitting An Feature Suggestion](#before-submitting-an-feature-suggestion) - - [How Do I Submit A (Good) Feature Suggestion?](#how-do-i-submit-a--good--feature-suggestion-) - - [🎮 Game Server Requests](#game-server-requests) - - [Before Submitting a Game Server Request](#before-submitting-a-game-server-request) - - [How Do I Submit A (Good) Game Server Request?](#how-do-i-submit-a--good--game-server-request-) - - [🎮 Game Server Specific Issues](#game-server-specific-issues) -- [💻 Code Contributions](#code-contributions) - - [Pull Requests](#pull-requests) - - [Pull Request naming convention](#pull-request-naming-convention) - - [Testing](#testing) - - [Pull Request Status Checks](#pull-request-status-checks) - - [Test Environment](#test-environment) - - [:wine_glass: Styleguides](#-wine-glass--styleguides) - - [Git Commit Messages](#git-commit-messages) - - [BASH Styleguide](#bash-styleguide) -- [:blue_book: Document Contributions](#-blue-book--document-contributions) - - [Documentation Styleguide](#documentation-styleguide) -- [Issue and Pull Request Labels](#issue-and-pull-request-labels) +- [Contributing to LinuxGSM](#contributing-to-linuxgsm) + - [Table of Contents](#table-of-contents) + - [Code of Conduct](#code-of-conduct) + - [🎉 Bug/Enhancement Contributions 🐛](#-bugenhancement-contributions-) + - [🐛Reporting Bugs](#reporting-bugs) + - [Before Submitting A Bug Report](#before-submitting-a-bug-report) + - [How Do I Submit A (Good) Bug Report?](#how-do-i-submit-a-good-bug-report) + - [🎉Suggesting Features](#suggesting-features) + - [Before Submitting An Feature Suggestion](#before-submitting-an-feature-suggestion) + - [How Do I Submit A (Good) Feature Suggestion?](#how-do-i-submit-a-good-feature-suggestion) + - [🎮 Game Server Requests](#-game-server-requests) + - [Before Submitting a Game Server Request](#before-submitting-a-game-server-request) + - [How Do I Submit A (Good) Game Server Request?](#how-do-i-submit-a-good-game-server-request) + - [🎮 Game Server Specific Issues](#-game-server-specific-issues) + - [💻 Code Contributions](#-code-contributions) + - [Pull Requests](#pull-requests) + - [Pull Request naming convention](#pull-request-naming-convention) + - [Testing](#testing) + - [Pull Request Status Checks](#pull-request-status-checks) + - [Test Environment](#test-environment) + - [🍷 Styleguides](#-styleguides) + - [Git Commit Messages](#git-commit-messages) + - [BASH Styleguide](#bash-styleguide) + - [:blue_book: Document Contributions](#blue_book-document-contributions) + - [Documentation Styleguide](#documentation-styleguide) + - [Issue and Pull Request Labels](#issue-and-pull-request-labels) ## Code of Conduct @@ -44,7 +45,7 @@ This project and everyone participating in it is governed by the [LinuxGSM Code This section guides you through submitting a bug report for LinuxGSM. Following these guidelines help maintainers and the community understand your report 📝, reproduce the behaviour💻, and find any related reports 🔎. -Before creating bug reports, please check [this list](https://github.com/GameServerManagers/linuxgsm/blob/master/CONTRIBUTING.md#before-submitting-a-bug-report) as you might find out that you don’t need to create one. When you are creating a bug report, please [include as many details as possible](https://github.com/GameServerManagers/linuxgsm/blob/master/CONTRIBUTING.md#how-do-i-submit-a-good-bug-report). Fill out [the required template](<[https://github.com/GameServerManagers/LinuxGSM/issues/new/choose](https://github.com/GameServerManagers/LinuxGSM/issues/new/choose)>), the information it asks for helps us resolve issues faster. +Before creating bug reports, please check [this list](https://github.com/GameServerManagers/linuxgsm/blob/master/CONTRIBUTING.md#before-submitting-a-bug-report) as you might find out that you don't need to create one. When you are creating a bug report, please [include as many details as possible](https://github.com/GameServerManagers/linuxgsm/blob/master/CONTRIBUTING.md#how-do-i-submit-a-good-bug-report). Fill out [the required template](<[https://github.com/GameServerManagers/LinuxGSM/issues/new/choose](https://github.com/GameServerManagers/LinuxGSM/issues/new/choose)>), the information it asks for helps us resolve issues faster. #### Before Submitting A Bug Report @@ -69,7 +70,7 @@ This section guides you through submitting a feature suggestion for LinuxGSM, in #### Before Submitting An Feature Suggestion -- **Check the** [**documentation**]() to confirm that the enhancement doesn’t already exist. +- **Check the** [**documentation**]() to confirm that the enhancement doesn't already exist. - **Check your** [**LinuxGSM version**](https://docs.linuxgsm.com/commands/update-lgsm)**.** A newer version of LinuxGSM may already have your enhancement. - **Perform a** [**cursory search**](https://github.com/search?q=org:GameServerManagers%20type:issues&type=Issues) to see if the enhancement has already been suggested. If it has **and the enhancement is still open**, add a comment to the existing issue and give it a thumbs up instead of opening a new one. @@ -122,7 +123,7 @@ The process described here has several goals: Please follow these steps to have your contribution considered by the maintainers: 1. Follow all check-list in [the template](https://github.com/GameServerManagers/LinuxGSM/blob/master/.github/pull_request_template.md) -2. Follow the [style guides](#styleguides) +2. Follow the [style guides](#🍷 Styleguides) 3. After you submit your pull request, verify that all [status checks](https://help.github.com/articles/about-status-checks/) are passing What if the status checks are failing? If a status check is failing, and you believe that the failure is unrelated to your change, please leave a comment on the pull request explaining why you believe the failure is unrelated. A maintainer will re-run the status check for you. If we conclude that the failure was a false positive, then we will open an issue to track that problem with our status check suite. @@ -145,7 +146,7 @@ For example: - If applied, this commit will **release version 1.0.0** - If applied, this commit will **merge pull request #123 from user/branch** -Notice how this doesn’t work for the other non-imperative forms: +Notice how this doesn't work for the other non-imperative forms: - If applied, this commit will **fixed bug with Y** - If applied, this commit will **change the behaviour of X** @@ -154,9 +155,9 @@ Notice how this doesn’t work for the other non-imperative forms: Below is an example of the subject line for a pull request: -**feat(alerts): add slack support to alerts** +`feat(alerts): add slack support to alerts` -**fix(csgoserver): remove SteamCMD auth requirement 32-bit workaround** +`fix(csgoserver): remove SteamCMD auth requirement 32-bit workaround` ### Testing @@ -177,7 +178,7 @@ githubrepo="LinuxGSM" githubbranch="master" ``` -### :wine_glass: Styleguides +### 🍷 Styleguides #### Git Commit Messages diff --git a/README.md b/README.md index db89b85481..844432b9d4 100644 --- a/README.md +++ b/README.md @@ -1,10 +1,10 @@

- LinuxGSM - Codacy grade - GitHub Workflow Status - Discord - SteamCMD - MIT License + LinuxGSM + Codacy grade + GitHub Workflow Status + Discord + SteamCMD + MIT License

[LinuxGSM](https://linuxgsm.com) is the command-line tool for quick, simple deployment and management of Linux dedicated game servers.