docs: expand contributing guide with CI, Prettier, JSDoc, and load/E2…#295
Merged
mikewheeleer merged 1 commit intoJun 19, 2026
Merged
Conversation
…E sections - Add explicit CI section detailing lint job (changed-files only + allow-failure full lint), test job (npm test + node --check), and concurrency behavior - Add Prettier formatting section with config summary and format command - Add JSDoc requirement for src/ functions with @description/@param/@returns - Add lint:fix tip for auto-fixing safe issues - Add load baseline and E2E sections with run instructions and safety notes - Add pre-existing test failures note so contributors know not to be blocked - Expand PR checklist with Prettier, JSDoc, and title length items - Add branch type table for common contribution types Closes Liquifact#291
Contributor
Author
|
Hi maintainer, you assigned this issue to me but I saw someone submitted a pr and closed it, but I have solved mine, please review. |
Contributor
|
great, the CI + Prettier + JSDoc + load/e2e additions make this contributing guide genuinely useful now. merging |
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
2 participants
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.
…E sections
Closes #291