10000 Update readme and add contributing guidelines · codellm-devkit/python-sdk@c68b8ac · GitHub
[go: up one dir, main page]

Skip to content

Commit c68b8ac

Browse files
committed
Update readme and add contributing guidelines
Signed-off-by: Rahul Krishna <i.m.ralk@gmail.com>
1 parent f41a413 commit c68b8ac

File tree

2 files changed

+72
-0
lines changed

2 files changed

+72
-0
lines changed

CONTRIBUTING.md

Lines changed: 66 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,66 @@
1+
# Contributing to Codellm-Devkit
2+
3+
Thank you for your interest in contributing to the Codellm-Devkit (CLDK)! Here we provide guidelines for contributing to any repository in the codellm-devkit organization.
4+
5+
## How to Contribute
6+
7+
### Issues and Discussions
8+
- For bugs and actionable items, please prefer creating an issue in the relevant repository
9+
- For open-ended or design discussions _specifically related to the specification_, use our [specification discussions](https://github.com/codellm-devkit/specification/discussions)
10+
- For other general discussions that are not suitable as issues, use our [organization discussions](https://github.com/orgs/codellm-devkit/discussions)
11+
12+
In all cases, please check for duplicates before creating new issues or discussions!
13+
14+
### Pull Requests
15+
We welcome PRs across all our repositories! When submitting:
16+
- Fork the repository
17+
- Follow existing code style
18+
- Include tests where applicable
19+
- Update documentation as needed
20+
- Link related issues
21+
22+
## Development Guidelines
23+
24+
### Code Quality
25+
- Follow the repository's established patterns
26+
- Include appropriate documentation
27+
- Add tests for new functionality
28+
- Handle errors appropriately
29+
30+
### Documentation
31+
- Keep READMEs current
32+
- Document configuration options
33+
- Provide clear examples
34+
- Include setup instructions
35+
36+
### Security
37+
- Follow security best practices
38+
- Implement proper input validation
39+
- Document security considerations
40+
41+
## Getting Started
42+
43+
1. Fork the repository
44+
2. Clone your fork:
45+
```bash
46+
git clone https://github.com/your-username/repository-name.git
47+
```
48+
3. Create a feature branch:
49+
```bash
50+
git checkout -b my-feature
51+
```
52+
4. Make your changes and commit:
53+
```bash
54+
git commit -m "Description of changes"
55+
```
56+
5. Push and create a Pull Request
57+
58+
## Code of Conduct
59+
60+
Please note that this project is released with a [Code of Conduct](CODE_OF_CONDUCT.md). By participating in this project you agree to abide by its terms.
61+
62+
## License
63+
64+
By contributing, you agree that your contributions will be licensed under the Apache 2.0 License.
65+
66+
Thank you for contributing to Codellm-Devkit!

README.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -71,6 +71,7 @@ For any questions, feedback, or suggestions, please contact the authors:
7171
- [Python](#python)
7272
- [C](#c)
7373
- [3. **Utilities and Extensions**](#3-utilities-and-extensions)
74+
- [Contributing](#contributing)
7475
- [Publication (papers and blogs related to CLDK)](#publication-papers-and-blogs-related-to-cldk)
7576

7677

@@ -238,6 +239,11 @@ The `cldk.utils` module provides additional support functionality:
238239

239240
These modules ensure robustness and clean error management across backend interactions and user API layers.
240241

242+
## Contributing
243+
244+
We invite contributors of all levels of experience! We would love to see you get involved in the project. See the [CONTRIBUTING](./CONTRIBUTING.md) guide to get started.
245+
246+
241247
### Publication (papers and blogs related to CLDK)
242248
1. Krishna, Rahul, Rangeet Pan, Raju Pavuluri, Srikanth Tamilselvam, Maja Vukovic, and Saurabh Sinha. "[Codellm-Devkit: A Framework for Contextualizing Code LLMs with Program Analysis Insights.](https://arxiv.org/pdf/2410.13007)" arXiv preprint arXiv:2410.13007 (2024).
243249
2. Pan, Rangeet, Myeongsoo Kim, Rahul Krishna, Raju Pavuluri, and Saurabh Sinha. "[Multi-language Unit Test Generation using LLMs.](https://arxiv.org/abs/2409.03093)" arXiv preprint arXiv:2409.03093 (2024).

0 commit comments

Comments
 (0)
0