From a3b29251f934d9519cb041e21fdfed1dba740037 Mon Sep 17 00:00:00 2001 From: Saoud Rizwan <7799382+saoudrizwan@users.noreply.github.com> Date: Tue, 24 Dec 2024 22:56:16 -0800 Subject: [PATCH] Update contributing guidelines --- CONTRIBUTING.md | 29 +++++++++-------------------- README.md | 2 +- 2 files changed, 10 insertions(+), 21 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 3ff8ef6b1..77c38f5e6 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -1,12 +1,8 @@ -# 🤖 Contributing to Cline +# Contributing to Cline -Welcome, human! We're thrilled you're interested in contributing to Cline. Whether you're fixing a bug, adding a feature, or improving our docs, every contribution makes Cline smarter! +We're thrilled you're interested in contributing to Cline. Whether you're fixing a bug, adding a feature, or improving our docs, every contribution makes Cline smarter! To keep our community vibrant and welcoming, all members must adhere to our [Code of Conduct](CODE_OF_CONDUCT.md). -## ✌️ Being Part of the Community - -We have an awesome, diverse, and inclusive community of humans (and friendly AI assistants). To keep our community vibrant and welcoming, all members must adhere to our [Code of Conduct](CODE_OF_CONDUCT.md). - -## 🐛 Reporting Bugs or Issues +## Reporting Bugs or Issues Bug reports help make Cline better for everyone! Before creating a new issue, please [search existing ones](https://github.com/cline/cline/issues) to avoid duplicates. When you're ready to report a bug, head over to our [issues page](https://github.com/cline/cline/issues/new/choose) where you'll find a template to help you with filling out the relevant information. @@ -14,15 +10,13 @@ Bug reports help make Cline better for everyone! Before creating a new issue, pl 🔐 Important: If you discover a security vulnerability, please use the Github security tool to report it privately. -## 🎯 Deciding What to Work On - -See something that could be improved? Feel free to create a pull request directly! Whether it's fixing a typo or adding a cool new AI feature, we love surprises (the good kind, not the "undefined is not a function" kind). +## Deciding What to Work On Looking for a good first contribution? Check out issues labeled ["good first issue"](https://github.com/cline/cline/labels/good%20first%20issue) or ["help wanted"](https://github.com/cline/cline/labels/help%20wanted). These are specifically curated for new contributors and areas where we'd love some help! If you're planning to work on a bigger feature, please create an issue first so we can discuss whether it aligns with Cline's vision. -## 💻 Writing and Submitting Code +## Writing and Submitting Code Anyone can contribute code to Cline, but we ask that you follow these guidelines to ensure your contributions can be smoothly integrated: @@ -30,7 +24,7 @@ Anyone can contribute code to Cline, but we ask that you follow these guidelines - Limit PRs to a single feature or bug fix - Split larger changes into smaller, related PRs - - Try and limit the PR to a single commit + - Break changes into logical commits that can be reviewed independently 2. **Code Quality** @@ -46,25 +40,20 @@ Anyone can contribute code to Cline, but we ask that you follow these guidelines - Update existing tests if your changes affect them - Include both unit tests and integration tests where appropriate -4. **Documentation** - - - Update documentation for any changed functionality - - Update the README if your changes affect usage or setup - -5. **Commit Guidelines** +4. **Commit Guidelines** - Write clear, descriptive commit messages - Use conventional commit format (e.g., "feat:", "fix:", "docs:") - Reference relevant issues in commits using #issue-number -6. **Before Submitting** +5. **Before Submitting** - Rebase your branch on the latest main - Ensure your branch builds successfully - Double-check all tests are passing - Review your changes for any debugging code or console logs -7. **Pull Request Description** +6. **Pull Request Description** - Clearly describe what your changes do - Include steps to test the changes - List any breaking changes diff --git a/README.md b/README.md index 80fd571c7..3e28c21e6 100644 --- a/README.md +++ b/README.md @@ -116,7 +116,7 @@ Thanks to the [Model Context Protocol](https://github.com/modelcontextprotocol), ## Contributing -To contribute to the project, start by exploring [open issues](https://github.com/cline/cline/issues) or checking our [feature request board](https://github.com/cline/cline/discussions/categories/feature-requests?discussions_q=is%3Aopen+category%3A%22Feature+Requests%22+sort%3Atop). We'd also love to have you join our [Discord](https://discord.gg/cline) to share ideas and connect with other contributors. If you're interested in joining the team, check out our [careers page](https://cline.bot/join-us)! +To contribute to the project, start with our [Contributing Guide](CONTRIBUTING.md) to learn the basics. You can also join our [Discord](https://discord.gg/cline) to chat with other contributors in the #contributors channel. If you're looking for full-time work, check out our open positions on our [careers page](https://cline.bot/join-us)!
Local Development Instructions