github/cline
7
0
Fork 0
mirror of https://github.com/cline/cline.git synced 2025-06-03 03:59:07 +00:00
Code Issues Packages Projects Releases Wiki Activity

Update contributing guidelines

Browse Source
This commit is contained in:
Saoud Rizwan 2024-12-24 22:56:16 -08:00
parent 9822ee79b6
commit a3b29251f9
2 changed files with 10 additions and 21 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

29
CONTRIBUTING.md
View File

@ -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 ## Reporting Bugs or Issues
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
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. 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
🔐 <b>Important:</b> If you discover a security vulnerability, please use the <a href="https://github.com/cline/cline/security/advisories/new">Github security tool to report it privately</a>. 🔐 <b>Important:</b> If you discover a security vulnerability, please use the <a href="https://github.com/cline/cline/security/advisories/new">Github security tool to report it privately</a>.
</blockquote> </blockquote>
## 🎯 Deciding What to Work On ## 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).
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! 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. 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: 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 - Limit PRs to a single feature or bug fix
- Split larger changes into smaller, related PRs - 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** 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 - Update existing tests if your changes affect them
- Include both unit tests and integration tests where appropriate - Include both unit tests and integration tests where appropriate
4. **Documentation** 4. **Commit Guidelines**
- Update documentation for any changed functionality
- Update the README if your changes affect usage or setup
5. **Commit Guidelines**
- Write clear, descriptive commit messages - Write clear, descriptive commit messages
- Use conventional commit format (e.g., "feat:", "fix:", "docs:") - Use conventional commit format (e.g., "feat:", "fix:", "docs:")
- Reference relevant issues in commits using #issue-number - Reference relevant issues in commits using #issue-number
6. **Before Submitting** 5. **Before Submitting**
- Rebase your branch on the latest main - Rebase your branch on the latest main
- Ensure your branch builds successfully - Ensure your branch builds successfully
- Double-check all tests are passing - Double-check all tests are passing
- Review your changes for any debugging code or console logs - Review your changes for any debugging code or console logs
7. **Pull Request Description** 6. **Pull Request Description**
- Clearly describe what your changes do - Clearly describe what your changes do
- Include steps to test the changes - Include steps to test the changes
- List any breaking changes - List any breaking changes

2
README.md
View File

@ -116,7 +116,7 @@ Thanks to the [Model Context Protocol](https://github.com/modelcontextprotocol),
## Contributing ## 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)!
<details> <details>
<summary>Local Development Instructions</summary> <summary>Local Development Instructions</summary>