docs: enhance developer guide with linting rules and env setup (#379)#467
Open
MsParadox wants to merge 1 commit into
Open
docs: enhance developer guide with linting rules and env setup (#379)#467MsParadox wants to merge 1 commit into
MsParadox wants to merge 1 commit into
Conversation
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Pull Request 🚀
Description
This PR addresses the documentation gap highlighted in Issue #379.
To improve the onboarding experience for new open-source contributors, I have updated the documentation to explicitly cover the
.envsetup and the mandatory code quality checks.Changes Made:
CONTRIBUTING.md: Added a new "Code Quality & Linting" section that instructs contributors to runnode fix_lint.mjsbefore opening a PR.DEVELOPER_GUIDE.md: Clarified the Environment Variables step to explicitly instruct users to copy from.env.example.DEVELOPER_GUIDE.md: Added the linting script requirement to the "Contribution Workflow" checklist.Related Issue
Closes #379
Type of Change
Screenshots / Videos (if applicable)
N/A - Documentation only.
Testing Done
Checklist
Contributor Declaration