docs: adds a guide for contributors #773
Draft
+11
−0
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
- Add structured contribution guidelines following OSS best practices - Include development setup with environment configuration - Document code quality requirements (linting, formatting, testing) - Add PR guidelines and community standards - Reference official documentation for detailed setup
|
@Chesars is attempting to deploy a commit to the LangChain Team on Vercel. A member of the Team first needs to authorize it. |
Chesars
changed the title
- Removed unverified commands (yarn test:int, yarn eval:single) - Simplified structure and removed speculative policies - Added note about format:check issues with /dist files - Focused on essential setup steps and verified commands only - Reduced from 175 to 81 lines while keeping all necessary information
Chesars
force-pushed
the
add-contributing-guide
branch
from
c641f43 to
6bd1175
Compare
- Added detailed step-by-step GitHub App creation instructions - Included all required permissions, webhooks, and OAuth settings - Added credential collection steps with specific locations - Clarified GitHub App vs OAuth App differences - Added ngrok setup for webhook URL - Included installation requirements after app creation
- Changed Node.js requirement to "18 or higher" for future compatibility - Added specific Yarn version requirement (3.5.1 or higher) - Added Git as an explicit requirement - Made requirements section more standard and clear
- Removed unnecessary note about format:check and /dist files - Simplified lint command description - Focused on essential information only - Made guide more minimalist and actionable
- Add note explaining yarn build is not needed for development - Clarify ngrok port 2024 is for agent service - Add verification section with localhost URLs - Mark production build as optional in workflow
Palashio
reviewed
Aug 27, 2025
Contributor
Palashio
left a comment
Palashio
left a comment
There was a problem hiding this comment.
thanks for this -- just one small nit
Git is a basic development tool that doesn't need to be explicitly listed in setup requirements.
Add reference to apps/open-swe-v2 Deep Agents system (in progress)
Removed detailed development setup instructions and requirements for Node.js and Yarn from the CONTRIBUTING.md file.
Chesars
changed the title
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.
Hi! This adds a contributing guide to help new developers to contribute to Open SWE.