docs: add comprehensive CONTRIBUTING.md guide#97
docs: add comprehensive CONTRIBUTING.md guide#97ManishPanda-ta wants to merge 4 commits intomlc-ai:mainfrom
Conversation
- Add complete contribution guidelines - Include setup instructions and prerequisites - Document development workflow and branching strategy - Add code style guidelines for TypeScript and React - Define PR process and review workflow - Include testing guidelines - Add documentation standards - List community resources and issue labels Fixes mlc-ai#91
Summary of ChangesHello @ManishPanda-ta, I'm Gemini Code Assist1! I'm currently reviewing this pull request and will post my feedback shortly. In the meantime, here's a summary to help you and other reviewers quickly get up to speed! This pull request significantly enhances the project's contributor experience by introducing a comprehensive Highlights
🧠 New Feature in Public Preview: You can now enable Memory to help Gemini Code Assist learn from your team's feedback. This makes future code reviews more consistent and personalized to your project's style. Click here to enable Memory in your admin console. Changelog
Activity
Using Gemini Code AssistThe full guide for Gemini Code Assist can be found on our documentation page, here are some quick tips. Invoking Gemini You can request assistance from Gemini at any point by creating a comment using either
Customization To customize Gemini Code Assist for GitHub experience, repository maintainers can create a configuration file and/or provide a custom code review style guide (such as PEP-8 for Python) by creating and adding files to a Limitations & Feedback Gemini Code Assist may make mistakes. Please leave feedback on any instances where its feedback is incorrect or counter productive. You can react with 👍 and 👎 on @gemini-code-assist comments. If you're interested in giving your feedback about your experience with Gemini Code Assist for Github and other Google products, sign up here. You can also get AI-powered code generation, chat, as well as code reviews directly in the IDE at no cost with the Gemini Code Assist IDE Extension. Footnotes
|
![gemini-code-assist[bot]](https://avatars.githubusercontent.com/in/956858?s=60&v=4){kind=small}
There was a problem hiding this comment.
Code Review
This is an excellent pull request that adds a comprehensive CONTRIBUTING.md file and detailed implementation plans. The contribution guide is well-structured and will be a great resource for new contributors, significantly improving the onboarding experience. I've identified a few minor issues in CONTRIBUTING.md, such as a broken link and references to npm scripts that don't exist. My feedback is detailed in the specific comments. Overall, this is a valuable addition to the project.
|
|
||
| ## Code of Conduct | ||
|
|
||
| This project follows the [MLC.ai Community Code of Conduct](https://github.com/mlc-ai). By participating, you are expected to uphold this code. Please report unacceptable behavior to the project maintainers. |
There was a problem hiding this comment.
The link to the MLC.ai Community Code of Conduct points to the organization's main GitHub page instead of the Code of Conduct file itself. Please update it to point directly to the CODE_OF_CONDUCT.md file for clarity.
| This project follows the [MLC.ai Community Code of Conduct](https://github.com/mlc-ai). By participating, you are expected to uphold this code. Please report unacceptable behavior to the project maintainers. | |
| This project follows the [MLC.ai Community Code of Conduct](https://github.com/mlc-ai/.github/blob/main/CODE_OF_CONDUCT.md). By participating, you are expected to uphold this code. Please report unacceptable behavior to the project maintainers. |
|
|
||
| # Auto-fix linting issues | ||
| npm run lint:fix | ||
|
|
||
| # Format code (if using Prettier) | ||
| npm run format |
There was a problem hiding this comment.
The guide mentions npm run lint:fix and npm run format, but these scripts are not defined in package.json. This could be confusing for contributors. Please remove these commands from the guide to avoid this confusion.
| ```bash | ||
| # Run all tests | ||
| npm test | ||
|
|
||
| # Run tests in watch mode | ||
| npm test -- --watch | ||
|
|
||
| # Run tests with coverage | ||
| npm test -- --coverage | ||
| ``` |
There was a problem hiding this comment.
The npm test script is mentioned multiple times in the guide (e.g., here and on line 240), but it's not defined in package.json. This will cause an error for contributors who try to run tests. Please either add a test script to package.json or remove the instructions for running tests from this guide.
- Rename plan file to match actual issue number created by ManishPanda-ta - Update all mlc-ai#89 references to mlc-ai#91 throughout the file - Update reporter from @Arunvallal to @ManishPanda-ta - Add references to duplicate issues mlc-ai#89 and mlc-ai#90 - Update PR reference to mlc-ai#97 Relates to mlc-ai#91
- Add license, Next.js, and TypeScript badges - Add detailed table of contents - Expand overview with project mission - Enhance key features descriptions with better formatting - Add backup files for reference - Include blueprint generator prompt file Updates for better project documentation and contributor onboarding.
1 participant
Description
Adds a comprehensive CONTRIBUTING.md file to guide contributors through the entire contribution process, from setup to PR submission.
Fixes Issues
Fixes #91
Also addresses #89 and #90 (duplicate requests)
What's Included
This PR adds:
1. CONTRIBUTING.md (515 lines)
A complete contribution guide with:
2. Implementation Plans
plan-85.md- Comprehensive implementation plan for issue [Bug] chat.weblm.ai not loading LLMs #85 (model loading bug)plan-89.md- Implementation plan for this CONTRIBUTING.md featureBenefits
This contribution guide will:
✅ Lower the barrier to entry for new contributors
✅ Improve code quality through clear standards and examples
✅ Reduce maintainer workload by setting expectations upfront
✅ Speed up PR reviews with consistent, well-structured submissions
✅ Build a stronger community with clear communication channels
✅ Attract more contributors by being welcoming and organized
✅ Align with OSS best practices followed by major projects
Examples from Similar Projects
This guide follows the structure of successful OSS projects:
Screenshots
N/A - Documentation only
Testing
Type of Change
Additional Context
This addresses three related issues (#89, #90, #91) all requesting contribution guidelines. The growing community interest in the project makes this documentation essential for scaling contributions effectively.
Implementation Notes
What Works Well
Future Enhancements (Separate PRs)
.github/pull_request_template.md)Checklist
Ready for Review 🎉
Thank you for considering this contribution! Looking forward to feedback and helping build a more contributor-friendly project.