Contributing to Abora
Help make Abora better. All contributions are welcome.
Ways to Contribute
Report Bugs
Found an issue? Open a GitHub issue with details and error logs.
Suggest Features
Have a great idea? Open an issue to discuss it with the community.
Improve Documentation
Help others by fixing or expanding documentation and guides.
Contribute Code
Fix bugs, add features, or improve the codebase with pull requests.
Test Releases
Help test new versions and report compatibility issues.
Community Support
Help other users in discussions and forums.
Getting Started
- Fork the repository
Visit Abora on GitHub and click Fork
- Clone your fork
git clone https://github.com/YOUR-USERNAME/Abora-OS.git
- Create a branch
git checkout -b fix/your-fix-name
- Make your changes
Edit files and test your changes locally
- Commit your work
git commit -m "Fix: description of your fix"
- Push and create PR
Push to your fork and open a Pull Request
Development Workflow
Before submitting code, make sure to:
Run validation
./scripts/check-scripts.sh
Check all scripts for issues
Validate desktops
./scripts/check-desktops.sh
Verify desktop environment configs
Test your changes
make iso && make qemu-fresh
Build and test in QEMU
Code Style & Standards
- • Follow existing code patterns and conventions
- • Write clear, descriptive commit messages
- • Add comments for complex logic
- • Keep changes focused and atomic
- • Test your changes thoroughly
- • Update documentation if needed
Reporting Issues
When reporting a bug, include:
- Clear description of the problem
- Steps to reproduce
- Expected vs. actual behavior
- Your system info (desktop, version, etc.)
- Relevant error messages or logs
- Screenshots if applicable
Resources
Code of Conduct
Abora welcomes contributors of all backgrounds. We expect:
- Respectful and inclusive communication
- Constructive feedback and collaboration
- No harassment, discrimination, or hostility
- Focus on the code and ideas, not individuals
Thank you for helping make Abora better!