Skip to content

Commit ce28b44

Browse files
mrubensmrubens
committed
CODE_OF_CONDUCT and CONTRIBUTING from Cline
1 parent 7dcd105 commit ce28b44

File tree

2 files changed

+168
-0
lines changed

2 files changed

+168
-0
lines changed

‎CODE_OF_CONDUCT.md‎

Lines changed: 76 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,76 @@
1+
# Contributor Covenant Code of Conduct
2+
3+
## Our Pledge
4+
5+
In the interest of fostering an open and welcoming environment, we as
6+
contributors and maintainers pledge to making participation in our project and
7+
our community a harassment-free experience for everyone, regardless of age, body
8+
size, disability, ethnicity, sex characteristics, gender identity and expression,
9+
level of experience, education, socio-economic status, nationality, personal
10+
appearance, race, religion, or sexual identity and orientation.
11+
12+
## Our Standards
13+
14+
Examples of behavior that contributes to creating a positive environment
15+
include:
16+
17+
- Using welcoming and inclusive language
18+
- Being respectful of differing viewpoints and experiences
19+
- Gracefully accepting constructive criticism
20+
- Focusing on what is best for the community
21+
- Showing empathy towards other community members
22+
23+
Examples of unacceptable behavior by participants include:
24+
25+
- The use of sexualized language or imagery and unwelcome sexual attention or
26+
advances
27+
- Trolling, insulting/derogatory comments, and personal or political attacks
28+
- Public or private harassment
29+
- Publishing others' private information, such as a physical or electronic
30+
address, without explicit permission
31+
- Other conduct which could reasonably be considered inappropriate in a
32+
professional setting
33+
34+
## Our Responsibilities
35+
36+
Project maintainers are responsible for clarifying the standards of acceptable
37+
behavior and are expected to take appropriate and fair corrective action in
38+
response to any instances of unacceptable behavior.
39+
40+
Project maintainers have the right and responsibility to remove, edit, or
41+
reject comments, commits, code, wiki edits, issues, and other contributions
42+
that are not aligned to this Code of Conduct, or to ban temporarily or
43+
permanently any contributor for other behaviors that they deem inappropriate,
44+
threatening, offensive, or harmful.
45+
46+
## Scope
47+
48+
This Code of Conduct applies both within project spaces and in public spaces
49+
when an individual is representing the project or its community. Examples of
50+
representing a project or community include using an official project e-mail
51+
address, posting via an official social media account, or acting as an appointed
52+
representative at an online or offline event. Representation of a project may be
53+
further defined and clarified by project maintainers.
54+
55+
## Enforcement
56+
57+
Instances of abusive, harassing, or otherwise unacceptable behavior may be
58+
reported by contacting the project team at [email protected]. All complaints
59+
will be reviewed and investigated and will result in a response that
60+
is deemed necessary and appropriate to the circumstances. The project team is
61+
obligated to maintain confidentiality with regard to the reporter of an incident.
62+
Further details of specific enforcement policies may be posted separately.
63+
64+
Project maintainers who do not follow or enforce the Code of Conduct in good
65+
faith may face temporary or permanent repercussions as determined by other
66+
members of the project's leadership.
67+
68+
## Attribution
69+
70+
This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
71+
available at https://www.contributor-covenant.org/version/1/4/code-of-conduct.html
72+
73+
[homepage]: https://www.contributor-covenant.org
74+
75+
For answers to common questions about this code of conduct, see
76+
https://www.contributor-covenant.org/faq

‎CONTRIBUTING.md‎

Lines changed: 92 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,92 @@
1+
# Contributing to Cline
2+
3+
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).
4+
5+
## Reporting Bugs or Issues
6+
7+
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.
8+
9+
<blockquote class='warning-note'>
10+
🔐 <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>.
11+
</blockquote>
12+
13+
## Deciding What to Work On
14+
15+
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!
16+
17+
We also welcome contributions to our [documentation](https://github.com/cline/cline/tree/main/docs)! Whether it's fixing typos, improving existing guides, or creating new educational content - we'd love to build a community-driven repository of resources that helps everyone get the most out of Cline. You can start by diving into `/docs` and looking for areas that need improvement.
18+
19+
If you're planning to work on a bigger feature, please create a [feature request](https://github.com/cline/cline/discussions/categories/feature-requests?discussions_q=is%3Aopen+category%3A%22Feature+Requests%22+sort%3Atop) first so we can discuss whether it aligns with Cline's vision.
20+
21+
## Development Setup
22+
23+
1. **VS Code Extensions**
24+
25+
- When opening the project, VS Code will prompt you to install recommended extensions
26+
- These extensions are required for development - please accept all installation prompts
27+
- If you dismissed the prompts, you can install them manually from the Extensions panel
28+
29+
2. **Local Development**
30+
- Run `npm run install:all` to install dependencies
31+
- Run `npm run test` to run tests locally
32+
- Before submitting PR, run `npm run format:fix` to format your code
33+
34+
## Writing and Submitting Code
35+
36+
Anyone can contribute code to Cline, but we ask that you follow these guidelines to ensure your contributions can be smoothly integrated:
37+
38+
1. **Keep Pull Requests Focused**
39+
40+
- Limit PRs to a single feature or bug fix
41+
- Split larger changes into smaller, related PRs
42+
- Break changes into logical commits that can be reviewed independently
43+
44+
2. **Code Quality**
45+
46+
- Run `npm run lint` to check code style
47+
- Run `npm run format` to automatically format code
48+
- All PRs must pass CI checks which include both linting and formatting
49+
- Address any ESLint warnings or errors before submitting
50+
- Follow TypeScript best practices and maintain type safety
51+
52+
3. **Testing**
53+
54+
- Add tests for new features
55+
- Run `npm test` to ensure all tests pass
56+
- Update existing tests if your changes affect them
57+
- Include both unit tests and integration tests where appropriate
58+
59+
4. **Version Management with Changesets**
60+
61+
- Create a changeset for any user-facing changes using `npm run changeset`
62+
- Choose the appropriate version bump:
63+
- `major` for breaking changes (1.0.0 → 2.0.0)
64+
- `minor` for new features (1.0.0 → 1.1.0)
65+
- `patch` for bug fixes (1.0.0 → 1.0.1)
66+
- Write clear, descriptive changeset messages that explain the impact
67+
- Documentation-only changes don't require changesets
68+
69+
5. **Commit Guidelines**
70+
71+
- Write clear, descriptive commit messages
72+
- Use conventional commit format (e.g., "feat:", "fix:", "docs:")
73+
- Reference relevant issues in commits using #issue-number
74+
75+
6. **Before Submitting**
76+
77+
- Rebase your branch on the latest main
78+
- Ensure your branch builds successfully
79+
- Double-check all tests are passing
80+
- Review your changes for any debugging code or console logs
81+
82+
7. **Pull Request Description**
83+
- Clearly describe what your changes do
84+
- Include steps to test the changes
85+
- List any breaking changes
86+
- Add screenshots for UI changes
87+
88+
## Contribution Agreement
89+
90+
By submitting a pull request, you agree that your contributions will be licensed under the same license as the project ([Apache 2.0](LICENSE)).
91+
92+
Remember: Contributing to Cline isn't just about writing code - it's about being part of a community that's shaping the future of AI-assisted development. Let's build something amazing together! 🚀

0 commit comments

Comments
 (0)