Skip to content

Commit

Permalink
Doc: Add instructions on how to run linting checks (#232)
Browse files Browse the repository at this point in the history
* fix: formatting issues

* doc: add instructions on how to perform linting checks

* doc: add pointer to checks

* doc: add documentation as an additional option in PR template
  • Loading branch information
alvyynm authored Aug 13, 2024
1 parent 7f223e6 commit 2b09e14
Showing 1 changed file with 17 additions and 9 deletions.
26 changes: 17 additions & 9 deletions .github/PULL_REQUEST_TEMPLATE
Original file line number Diff line number Diff line change
@@ -1,20 +1,28 @@
[Have you read the contributing guidelines ?](https://github.com/SpaceyaTech/SYT-Web-Redesign/blob/Dev/docs/CONTRIBUTING.md)

# What is the purpose of your *pull request*?
# What is the purpose of your _pull request_?

- [ ] Bug fix
- [ ] New feature
- [ ] Bug fix
- [ ] New feature
- [ ] Documentation

# Proposed changes


# Warning

Please read these points carefully and answer honestly with an `X`
into all the boxes. Example : [X]
into all the boxes. Example : [X]

Before submitting a _pull request_ make sure you have:

- [ ] Read the guidelines for contributing.
- [ ] Wrote some tests.
- [ ] Respected the linting guidelines (read the guide below for help).

## How to Check and Fix Linting Issues

Run `npm run validate`. This command will run prettier and eslint checks to ensure linting guidelines are respected.

Before submitting a *pull request* make sure you have:
- If the command exits with code 0 (build is successful), there are no linting issues.

- [ ] Read the guidelines for contributing.
- [ ] Wrote some tests.
- [ ] Respected the linting guidelines.
- If the command exits with a code other than 0, scroll up the command output and look for identified linting issues. Fix them and revalidate to check if the issues have been resolved by re-running the command.

0 comments on commit 2b09e14

Please sign in to comment.