|
| 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
100B7
div> |
| 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! |
0 commit comments