docs: add CONTRIBUTING.md to guide contributors#100
Conversation
Add comprehensive contribution guidelines including: - Development setup and prerequisites - How to find and claim issues - Development workflow and branching strategy - Coding standards and conventions - Pull request process - Code of conduct - Community support channels Closes mlc-ai#89
Summary of ChangesHello @singasaiprasad-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 introduces a new 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 pull request introduces a comprehensive CONTRIBUTING.md file to guide new contributors. The document is well-structured, detailed, and covers all essential aspects from setting up the development environment to the pull request process. This is a valuable addition to the project. I've pointed out one minor typographical error for correction. Otherwise, the changes look great.
| - **Screenshots or videos** if applicable | ||
| - **Console logs** or error messages | ||
|
|
||
| Use the [bug report template](.github/ISSUE_TEMPLATE/bug_report.yml) when creating an issue . |
There was a problem hiding this comment.
There's a minor typo in this line. An extra space exists before the period. Removing it will improve the document's professionalism.
| Use the [bug report template](.github/ISSUE_TEMPLATE/bug_report.yml) when creating an issue . | |
| Use the [bug report template](.github/ISSUE_TEMPLATE/bug_report.yml) when creating an issue. |
1 participant
Description
This PR adds a comprehensive
CONTRIBUTING.mdfile to guide contributors to the WebLLM Chat project.Changes
Created
CONTRIBUTING.mdwith the following sections:Benefits
✅ Lowers barrier for new contributors
✅ Standardizes contribution process
✅ Improves code quality and consistency
✅ Reduces maintainer burden
✅ Creates healthier open-source community
Testing
Related Issues
Closes #89
Additional Notes
This guide is based on:
The file can be further refined based on maintainer feedback and community needs.
Thank you for considering this contribution! 🎉