docs: improve contributor onboarding docs #45
Conversation
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
✅ Deploy Preview for pyconfhyd2026 ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
There was a problem hiding this comment.
Pull request overview
This pull request enhances the contributor onboarding experience by adding explicit dependency installation instructions and a quick setup checklist, while also cleaning up obsolete documentation.
Changes:
- Added a dedicated "Install Dependencies" step (step 4) in the setup instructions with examples for npm, yarn, and pnpm
- Introduced a "Quick Setup Checklist" section for contributors with essential setup steps
- Removed the obsolete
npm run exportcommand from claude.md (verified that this script doesn't exist in package.json)
Reviewed changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated no comments.
| File | Description |
|---|---|
| README.md | Added dependency installation step and quick setup checklist to improve contributor onboarding |
| claude.md | Removed obsolete npm run export command from the Build & Deploy section |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
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.
Summary:
This pull request improves contributor onboarding documentation by adding explicit dependency installation instructions, a quick setup checklist, and relevant repository metadata. It also removes an obsolete deployment command from the developer documentation.
Changes:
README.mdwith examples fornpm,yarn, andpnpmREADME.mdclaude.mdPR Checks:
make pre-pushcommand).make pre-pushcommand).