Contributing
How to Contribute
We welcome contributions to all Project Resistor initiatives. This page outlines the process for submitting your work.
Before You Start
- Review our Documentation to understand the project you want to contribute to
- Find the relevant repository:
- Kernel infrastructure: project-resistor-kernel
- Atomic images and packages: project-resistor
- Check existing issues and work to avoid duplication
- Discuss significant changes in community channels first
Development Workflow
Setting Up Your Environment
- Fork the relevant repository
- Clone your fork locally
- Set up the development environment following project-specific documentation
- Create a feature branch for your work
Making Changes
- Follow the existing code style and conventions
- Write clear, descriptive commit messages
- Add or update documentation for your changes
- Add tests where applicable
Submitting Your Contribution
- Push your changes to your fork
- Open a pull request against the main repository
- Fill out the PR template with details about your changes
- Respond to feedback during code review
Code Review Process
- All contributions go through peer review
- Reviewers may request changes or improvements
- Address feedback promptly and professionally
- Once approved, maintainers will merge your contribution
Types of Contributions
Code Contributions
- Bug fixes
- New features
- Performance improvements
- Refactoring
Documentation Contributions
- Improving existing documentation
- Adding examples and tutorials
- Fixing typos and clarity issues
- Translating documentation
Testing Contributions
- Adding test coverage
- Improving test infrastructure
- Reporting bugs with reproduction steps
Where to Get Help
- Issues - File bugs or feature requests in the relevant repository
- Discussions - Ask questions and discuss ideas
- Chat - Real-time help from the community
Community Guidelines
- Be respectful and constructive
- Help others learn and grow
- Focus on what’s best for the project
- Follow the Fedora Code of Conduct