diff --git a/.github/ISSUE_TEMPLATE/bug-report.yml b/.github/ISSUE_TEMPLATE/bug-report.yml index 2ad5fe20..1c7be765 100644 --- a/.github/ISSUE_TEMPLATE/bug-report.yml +++ b/.github/ISSUE_TEMPLATE/bug-report.yml @@ -13,7 +13,7 @@ body: id: bug-description attributes: label: Describe the bug - description: A clear and concise description of what the bug is. If you intend to submit a PR for this issue, tell us in the description. Thanks! + description: A clear and concise description, in PLAIN ENGLISH ONLY, of what the bug is. If you intend to submit a PR for this issue, tell us in the description. Thanks! placeholder: Bug description validations: required: true diff --git a/.github/ISSUE_TEMPLATE/feature-request.yml b/.github/ISSUE_TEMPLATE/feature-request.yml index d00bd0c7..0a2abb79 100644 --- a/.github/ISSUE_TEMPLATE/feature-request.yml +++ b/.github/ISSUE_TEMPLATE/feature-request.yml @@ -25,7 +25,7 @@ body: id: feature-description attributes: label: Clear and concise description of the feature you are proposing - description: A clear and concise description of what the feature is. + description: A clear and concise description of what the feature is, in PLAIN ENGLISH ONLY. placeholder: 'Example: a token generator tool' validations: required: true @@ -54,3 +54,5 @@ body: required: true - label: Check that the feature can be implemented in a client side only app (IT-Tools is client side only, no server). required: true + - label: Everything is written in PLAIN ENGLISH + required: true diff --git a/.github/PULL_REQUEST_TEMPLATE/pull_request_template.md b/.github/PULL_REQUEST_TEMPLATE/pull_request_template.md index 26eb22f8..37476625 100644 --- a/.github/PULL_REQUEST_TEMPLATE/pull_request_template.md +++ b/.github/PULL_REQUEST_TEMPLATE/pull_request_template.md @@ -19,7 +19,8 @@ ### Before submitting the PR, please make sure you do the following -- [ ] Submit the PR against the `dev` branch. +- [ ] Submit the PR against the `chore/all-my-stuffs` branch. - [ ] Check that there isn't already a PR that solves the problem the same way to avoid creating a duplicate. -- [ ] Provide a description in this PR that addresses **what** the PR is solving, or reference the issue that it solves (e.g. `fixes #123`). +- [ ] Provide a description, in PLAIN ENGLISH ONLY, in this PR that addresses **what** the PR is solving, or reference the issue that it solves (e.g. `fixes #123`). +- [ ] Run `pnpm install --ignore-scripts && pnpm lint --fix && pnpm typecheck` to ensure pnpm lock, eslint and typecheck are ok - [ ] Ideally, include relevant tests that fail without this PR but pass with it. \ No newline at end of file diff --git a/README.md b/README.md index 4f425f87..88850779 100644 --- a/README.md +++ b/README.md @@ -307,6 +307,14 @@ pnpm test pnpm lint ``` +### Ensure CI (lock, eslint, typecheck) will succeed + +Before submitting a PR, run: + +```sh +pnpm install --ignore-scripts && pnpm lint --fix && pnpm typecheck +``` + ### Create a new tool To create a new tool, there is a script that generate the boilerplate of the new tool, simply run: