Skip to content

Commit 5f71645

Browse files
committed
docs: Update directions on how to resolve lint errors beofre making features
1 parent f04bb15 commit 5f71645

File tree

1 file changed

+9
-0
lines changed

1 file changed

+9
-0
lines changed

CONTRIBUTING.md

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -211,6 +211,15 @@ You will create a new branch for each issue you work on. Doing all your work on
211211
git checkout -b your-branch-name
212212
```
213213

214+
### **3.2.1 Check for and resolve linting/prettier errors before making changes**
215+
216+
Before you begin working on any part of a file, always check for existing code errors in the codebase. This helps prevent introducing new issues and ensures a stable foundation for your work.
217+
218+
- Use your code editor's error checking tools or run the appropriate linting/compilation commands (e.g., `yarn lint`, `npm run lint`, or your IDE's error panel) to identify any errors in the files you plan to edit.
219+
- Resolve any errors you find before proceeding with your changes. If you are unsure how to fix an error, ask for help in the team Slack channel or consult the documentation.
220+
- Only begin implementing new features or fixes after confirming the file is error-free.
221+
- If you are unable to resolve the errors after making a reasonable effort, it is acceptable to use `--no-verify` when committing or pushing your changes. Please leave a comment in your pull request explaining why this was necessary.
222+
214223
### **3.3 Work on the Issue**
215224

216225
Every issue will contain action items you must complete before you are ready to submit a pull request. Be sure to use the checkboxes as you complete each action item so we can track your progress!

0 commit comments

Comments
 (0)