From 2908c15ea61d39a9fdee3485407e46e6bdd8a8a0 Mon Sep 17 00:00:00 2001 From: Veeck Date: Sat, 7 Jan 2023 20:13:25 +0100 Subject: [PATCH] Cleanup md files (#2994) Update the issue template and the contributing guidelines Co-authored-by: veeck --- .github/CONTRIBUTING.md | 7 ++++--- .github/{ISSUE_TEMPLATE.md => ISSUE_TEMPLATE/custom.md} | 0 CHANGELOG.md | 1 + 3 files changed, 5 insertions(+), 3 deletions(-) rename .github/{ISSUE_TEMPLATE.md => ISSUE_TEMPLATE/custom.md} (100%) diff --git a/.github/CONTRIBUTING.md b/.github/CONTRIBUTING.md index 0cd23540..ce7cccb4 100644 --- a/.github/CONTRIBUTING.md +++ b/.github/CONTRIBUTING.md @@ -6,7 +6,7 @@ We hold our code to standard, and these standards are documented below. ## Linters -If you wish to run our linters, use `npm run lint` without any arguments. +We use prettier for automatic linting of all our files: `npm run lint:prettier`. ### JavaScript: Run ESLint @@ -18,7 +18,7 @@ To run ESLint, use `npm run lint:js`. ### CSS: Run StyleLint -We use [StyleLint](https://stylelint.io) to lint our CSS. Our configuration is in our .stylelintrc file. +We use [StyleLint](https://stylelint.io) to lint our CSS. Our configuration is in our `.stylelintrc` file. To run StyleLint, use `npm run lint:css`. @@ -28,7 +28,8 @@ We use [Jest](https://jestjs.io) for JavaScript testing. To run all tests, use `npm run test`. -The specific test commands are defined in `package.json`. So you can also run the specific tests with other commands, e.g. `npm run test:unit` or `npx jest tests/e2e/env_spec.js`. +The specific test commands are defined in `package.json`. +So you can also run the specific tests with other commands, e.g. `npm run test:unit` or `npx jest tests/e2e/env_spec.js`. ## Submitting Issues diff --git a/.github/ISSUE_TEMPLATE.md b/.github/ISSUE_TEMPLATE/custom.md similarity index 100% rename from .github/ISSUE_TEMPLATE.md rename to .github/ISSUE_TEMPLATE/custom.md diff --git a/CHANGELOG.md b/CHANGELOG.md index ce720ba2..f4f3777f 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -14,6 +14,7 @@ _This release is scheduled to be released on 2023-04-01._ ### Updated - Use develop as target branch for dependabot +- Update issue template and contributing doc ### Fixed