Contributing
Thank you for your interest in contributing to caffyne shell! Development is driven entirely by the open-source community, and issues, pull requests, feature suggestions, or bug reports are always welcome.
Reporting Bugs
If you encounter unexpected behavior, system instability, or visual glitches:
- Search the Issues tab on GitHub to ensure the bug hasn't already been reported.
- If it's a new issue, open a report using the bug template.
- Include your Wayland compositor (e.g., Niri, Hyprland), system logs, and steps to reproduce the issue.
Suggesting Features
Have an idea for a new applet or customisation flag?
- Open a Feature Request on GitHub.
- Clearly describe the problem your idea solves and how you envision the user experience or visual layout.
Pull Requests
Want to write code, patch bugs, or improve documentation? Follow this collaborative workflow:
Fork and Clone
Fork the repository on GitHub and clone your fork locally to begin your development cycle.
Create a Feature Branch
Branch off from the main development line using a clear descriptive name:
git checkout -b feature/your-awesome-feature
Implement and Test
Make your changes, ensure your Python environment is active, and test the shell locally to guarantee no regressions.
Submit for Review
Commit your updates with clear, concise commit messages, push them to your fork, and open a Pull Request against our primary upstream repository.