Thank you for your interest in contributing to the Claude Code GitHub Action! This document provides guidelines and instructions for contributing.
By participating in this project, you agree to abide by our Code of Conduct.
There are many ways to contribute to this project:
- Report bugs: If you find a bug, please create an issue with detailed information about how to reproduce it.
- Suggest enhancements: New features or improvements to existing functionality can be proposed as issues.
- Submit pull requests: Implement new features or fix bugs by submitting pull requests.
- Fork the repository
- Create a feature branch (
git checkout -b feature/amazing-feature) - Make your changes
- Commit your changes (
git commit -m 'Add some amazing feature') - Push to the branch (
git push origin feature/amazing-feature) - Open a Pull Request
- Update the README.md with details of changes to the interface, if applicable.
- Update the version number in package.json following Semantic Versioning.
- Include meaningful commit messages that explain what changes were made and why.
- The PR should work against the main branch.
- You may merge the PR once it has approval, or ask maintainers to merge it for you.
When adding new functionality:
- Keep scripts modular and focused on specific tasks
- Ensure proper error handling
- Add detailed comments for complex logic
- Update the README.md with examples of how to use new features
By contributing to this project, you agree that your contributions will be licensed under the project's MIT License.