Skip to content

Doc: Add instructions on how to run linting checks #232

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 4 commits into from
Aug 13, 2024
Merged

Doc: Add instructions on how to run linting checks #232

Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
b4817b4
fix: formatting issues
alvyynm Aug 10, 2024
88bfe45
doc: add instructions on how to perform linting checks
alvyynm Aug 10, 2024
9c9acc2
doc: add pointer to checks
alvyynm Aug 10, 2024
1442325
doc: add documentation as an additional option in PR template
alvyynm Aug 10, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
26 changes: 17 additions & 9 deletions .github/PULL_REQUEST_TEMPLATE
View file
Open in desktop
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.
Loading