Thank you for your interest in contributing to this project! 🎉
- Fork the repository
- Clone your fork locally
- Create a new branch for your feature
- Make your changes
- Test your changes
- Submit a pull request
We welcome contributions in several areas:
- Use the issue tracker to report bugs
- Include reproduction steps
- Specify which image variant you're using
- Suggest new image variants
- Propose script improvements
- Request documentation enhancements
- Improve existing documentation
- Add missing information
- Fix typos and formatting
- New Dockerfile optimizations
- Script improvements
- Build automation enhancements
- Test all variants before submitting
- Ensure images build successfully
- Document size impact
- Follow existing optimization patterns
- Test on Windows and Linux (where applicable)
- Maintain backward compatibility
- Add appropriate error handling
- Update documentation
- Keep README.md updated
- Update relevant docs/ files
- Maintain consistent formatting
Before submitting changes:
- Build test: Ensure Dockerfiles build successfully
- Size test: Check image sizes with
scripts/utils/check-image-sizes.bat - Function test: Verify containers start and function properly
- Script test: Test any modified scripts
Please maintain the organized structure:
- Dockerfiles →
dockerfiles/ - Build scripts →
scripts/build/ - Push scripts →
scripts/push/ - Run scripts →
scripts/run/ - Utilities →
scripts/utils/ - Documentation →
docs/
- Check existing issues
- Review the documentation
- Ask questions in issue discussions
By contributing, you agree that your contributions will be licensed under the same license as the project.
Thank you for helping make this project better! 🙏