Thank you for your interest in contributing to MetalDeploy Action! This document provides guidelines and instructions for contributing.
If you find a bug or have a feature request, please open an issue on GitHub with:
- A clear description of the problem or feature
- Steps to reproduce (for bugs)
- Expected vs actual behavior
- Your environment details (OS, GitHub Actions version, etc.)
-
Fork the repository and create a new branch from
maingit checkout -b feature/your-feature-name
-
Set up pre-commit hooks (recommended):
pip install pre-commit pre-commit install
This will automatically format and lint your code before commits.
-
Make your changes following the code style and conventions
-
Test your changes if possible (manual testing is acceptable)
-
Update documentation if you've changed functionality
-
Commit your changes with clear, descriptive messages
git commit -m "Add feature: description of what you added" -
Push to your fork and open a Pull Request
git push origin feature/your-feature-name
-
Describe your changes in the PR description:
- What changed and why
- How to test the changes
- Any breaking changes
- Follow Python PEP 8 style guidelines
- Use meaningful variable and function names
- Add comments for complex logic
- Keep functions focused and single-purpose
- Update README.md if you add new features or change existing ones
- Keep code comments clear and helpful
- Update example workflows if behavior changes
This project includes a comprehensive test suite. Before submitting a PR, please ensure all tests pass.
See tests/README.md for detailed testing documentation, including:
- How to run tests
- How to write new tests
- Test structure and best practices
- Coverage reporting
Feel free to open an issue for questions or discussions about contributions.
Thank you for contributing! 🎉