mirror of
https://github.com/CommunitySolidServer/CommunitySolidServer.git
synced 2024-10-03 14:55:10 +00:00
style: Enforce linting rules on markdown files
* chore: add markdownlint-cli2 and config for mkdocs * style: enforce linting rules on mkdocs md files * chore: tweaks to markdownlint rules * style: linting changelog * style: linting release notes * style: linting .github md files * style: further linting of docs * style: linting readmes * chore: update linting script entries * docs: tweak release after rebase * chore: simplify root md linting config * chore: extend base config * chore: implement requested changes * chore: remove unnecessary exception * chore: fix comment type * styling: single config + list spacing * chore: implement requested changes * chore: use .cjs files for markdownlint config * chore: implement requested changes
This commit is contained in:
14
.github/.markdownlint-cli2.cjs
vendored
Normal file
14
.github/.markdownlint-cli2.cjs
vendored
Normal file
@@ -0,0 +1,14 @@
|
||||
|
||||
const options = require('../.markdownlint-cli2.cjs');
|
||||
"use strict";
|
||||
|
||||
module.exports = {
|
||||
globs: [ "**/*.md" ],
|
||||
config: {
|
||||
// Re-use the base config
|
||||
...options.config,
|
||||
|
||||
// Allow first line to not be top level heading
|
||||
MD041: false
|
||||
}
|
||||
};
|
||||
4
.github/ISSUE_TEMPLATE/bug-report.md
vendored
4
.github/ISSUE_TEMPLATE/bug-report.md
vendored
@@ -8,7 +8,9 @@ assignees: ''
|
||||
---
|
||||
|
||||
#### Environment
|
||||
- Server version: *Output of `community-solid-server --version` for a global or `npx community-solid-server --version` for a local installation*
|
||||
|
||||
- Server version: *Output of `community-solid-server --version` for a
|
||||
global or `npx community-solid-server --version` for a local installation*
|
||||
- Node.js version: *Output of `node -v`*
|
||||
- npm version: *Output of `npm -v`*
|
||||
|
||||
|
||||
2
.github/ISSUE_TEMPLATE/feature-request.md
vendored
2
.github/ISSUE_TEMPLATE/feature-request.md
vendored
@@ -7,7 +7,7 @@ assignees: ''
|
||||
|
||||
---
|
||||
|
||||
#### Feature description:
|
||||
#### Feature description
|
||||
|
||||
<!--In case you want to start a discussion about an idea, discussions are better suited for this https://github.com/CommunitySolidServer/CommunitySolidServer/discussions -->
|
||||
<!--A clear and concise description of what you want to happen.-->
|
||||
|
||||
18
.github/PULL_REQUEST_TEMPLATE.md
vendored
18
.github/PULL_REQUEST_TEMPLATE.md
vendored
@@ -1,6 +1,6 @@
|
||||
#### 📁 Related issues
|
||||
|
||||
<!--
|
||||
<!--
|
||||
Reference any relevant issues here. Closing keywords only have an effect when targeting the main branch. If there are no related issues, you must first create an issue through https://github.com/CommunitySolidServer/CommunitySolidServer/issues/new/choose
|
||||
-->
|
||||
|
||||
@@ -8,16 +8,16 @@ Reference any relevant issues here. Closing keywords only have an effect when ta
|
||||
|
||||
<!-- Describe the relevant changes in this PR. Also add notes that might be relevant for code reviewers. -->
|
||||
|
||||
|
||||
### ✅ PR check list
|
||||
|
||||
Before this pull request can be merged, a core maintainer will check whether
|
||||
* [ ] this PR is labeled with the correct semver label
|
||||
- semver.patch: Backwards compatible bug fixes.
|
||||
- semver.minor: Backwards compatible feature additions.
|
||||
- semver.major: Breaking changes. This includes changing interfaces or configuration behaviour.
|
||||
* [ ] the correct branch is targeted. Patch updates can target main, other changes should target the latest versions/* branch.
|
||||
* [ ] the RELEASE_NOTES.md document in case of relevant feature or config changes.
|
||||
* [ ] any relevant documentation was updated to reflect the changes in this PR.
|
||||
|
||||
* [ ] this PR is labeled with the correct semver label
|
||||
* semver.patch: Backwards compatible bug fixes.
|
||||
* semver.minor: Backwards compatible feature additions.
|
||||
* semver.major: Breaking changes. This includes changing interfaces or configuration behaviour.
|
||||
* [ ] the correct branch is targeted. Patch updates can target main, other changes should target the latest versions/* branch.
|
||||
* [ ] the RELEASE_NOTES.md document in case of relevant feature or config changes.
|
||||
* [ ] any relevant documentation was updated to reflect the changes in this PR.
|
||||
|
||||
<!-- Try to check these to the best of your abilities before opening the PR -->
|
||||
|
||||
Reference in New Issue
Block a user