diff --git a/.github/workflows/build.yaml b/.github/workflows/build.yaml index dddde19..9aef57d 100644 --- a/.github/workflows/build.yaml +++ b/.github/workflows/build.yaml @@ -15,17 +15,17 @@ jobs: strategy: matrix: node-version: - - 18 - - 20 - - lts/* - - latest + - "18" + - "20" + - "lts/*" + - "latest" steps: - uses: actions/checkout@v4 - name: Get PNPM version from package.json id: pnpm-version shell: bash - run: echo "pnpm_version=$(node -p 'require(`./package.json`).engines.pnpm')" >> $GITHUB_OUTPUT + run: echo "pnpm_version=$(node -p "require('./package.json').engines.pnpm")" >> "$GITHUB_OUTPUT" - name: Install pnpm uses: pnpm/action-setup@v4 diff --git a/.github/workflows/lint.yaml b/.github/workflows/lint.yaml index 00f9609..70f4dab 100644 --- a/.github/workflows/lint.yaml +++ b/.github/workflows/lint.yaml @@ -9,7 +9,9 @@ on: branches: - main -permissions: {} +permissions: + contents: read + jobs: lint: runs-on: ubuntu-latest diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index b568273..057c1f5 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -79,7 +79,7 @@ Before you start contributing, ensure you have the following prerequisites insta - Follow the existing coding style and formatting used in the documentation repository. - Ensure your changes are consistent with the overall tone and voice of the documentation. -- Make use of Vitepress's built-in features, such as frontmatter, custom components, and markdown extensions, where appropriate. +- Make use of Vitepress's built-in features, such as frontmatter, custom components, and Markdown extensions, where appropriate. - Write clear and concise documentation that is easy for users to understand. ### Code blocks @@ -103,7 +103,7 @@ specify blocks for multiple languages. Use the following syntax: ## Vitepress Markdown Extensions -Vitepress provides a variety of markdown extensions that can be used to enhance the documentation. +Vitepress provides a variety of Markdown extensions that can be used to enhance the documentation. You can find a list of available extensions in the [Vitepress documentation](https://vitepress.dev/guide/markdown). ## Thank You diff --git a/docs/en/contribution/maintainers/pr_guide.md b/docs/en/contribution/maintainers/pr_guide.md index 69ef35e..8003f73 100644 --- a/docs/en/contribution/maintainers/pr_guide.md +++ b/docs/en/contribution/maintainers/pr_guide.md @@ -13,7 +13,7 @@ and attract new people to help drive this project forward! ::: -We use [Github Labels](https://docs.github.com/en/issues/using-labels-and-milestones-to-track-work/managing-labels) +We use [GitHub Labels](https://docs.github.com/en/issues/using-labels-and-milestones-to-track-work/managing-labels) to automatically tag PRs with a version number on merge. This removes the tedious work of keeping version numbers up to date across several PRs at a time and eliminate Human error. The following custom labels, all of them following the pattern of `release/*`, are used by Mockbukkit: @@ -22,7 +22,7 @@ pattern of `release/*`, are used by Mockbukkit: |----------------------------------------------|:----------------------|:--|:---------------------------------------| | | Major Version (X.0.0) | | Only used for breaking changes | | | Minor Version (0.X.0) | | New Features | -| | Patch Version (0.0.X) | | Bug Fixes | +| | Patch Version (0.0.X) | | Bugfixes | | | None (-) | | Method Stubs or non code related fixes | -As you can probably tell, this project uses [Semantic Versioning](https://semver.org/). \ No newline at end of file +As you can probably tell, this project uses [Semantic Versioning](https://semver.org/).