mirror of
https://github.com/nenadilic84/claudex.git
synced 2025-10-28 00:02:05 -07:00
57dac558f4
- Update README with detailed usage instructions - Add GitHub community files (CONTRIBUTING, CODE_OF_CONDUCT, etc.) - Set up CI workflows for automated testing - Create CHANGELOG for version tracking - Add SECURITY guidelines - Update licensing and author information
41 lines
1.1 KiB
Markdown
41 lines
1.1 KiB
Markdown
# Contributing to claudex
|
|
|
|
Thank you for your interest in contributing to claudex! This document outlines how you can contribute to this project.
|
|
|
|
## Getting Started
|
|
|
|
1. Fork the repository
|
|
2. Clone your fork: `git clone https://github.com/your-username/claudex.git`
|
|
3. Set up the development environment as described in the README
|
|
4. Create a branch for your changes: `git checkout -b feature/your-feature-name`
|
|
|
|
## Pull Request Process
|
|
|
|
1. Make your changes and commit them using descriptive commit messages
|
|
2. Push your changes to your fork
|
|
3. Submit a pull request to the main repository
|
|
4. Your PR will be reviewed, and changes may be requested
|
|
|
|
## Development Guidelines
|
|
|
|
- Follow the existing code style
|
|
- Add tests for new features or bug fixes
|
|
- Update documentation as needed
|
|
|
|
## Testing
|
|
|
|
Before submitting your PR, make sure all tests pass:
|
|
|
|
```bash
|
|
pytest
|
|
```
|
|
|
|
## Code of Conduct
|
|
|
|
Please note that this project adheres to a code of conduct. By participating, you are expected to uphold this code.
|
|
|
|
## Questions?
|
|
|
|
If you have any questions about contributing, please open an issue for discussion.
|
|
|
|
Thank you for your contributions! |