Stasis

Contributing

Contributions make Stasis better for everyone! 💜

Please read our GitHub Contributing Guidelines before submitting anything.

Important:
- All new features, enhancements, or other contributions (except packaging or compositor work) must first go through an issue or bug report.
- Packaging for distributions and compositor integration can be submitted directly.
- Using the correct labels (`bug`, `feature request`, `packaging`, `compositor`, etc.) helps maintainers manage contributions efficiently.

Ways to Help

There are many ways to contribute to Stasis, no matter your skill level:

🐛

Report Bugs

Found something that's not working right? Open an issue on GitHub with:

  • Your distro and compositor
  • Steps to reproduce the problem
  • Expected vs actual behavior
  • Relevant logs from ~/.cache/stasis/stasis.log
Report an Issue →
💡

Suggest Features

Have an idea for a new feature or improvement? We'd love to hear it! Share:

  • Your use case and why it matters
  • How you envision it working
  • Any examples from other tools
Suggest a Feature →
🔧

Submit Pull Requests

Ready to dive into the code? Contributions welcome for:

  • Bug fixes and improvements
  • New features (discuss first!)
  • Code cleanup and optimization
  • Test coverage
View Pull Requests →
📦

Package for Distros

Help make Stasis available to more users by:

  • Creating packages for different distros
  • Maintaining existing packages
  • Testing on various systems
📖

Improve Documentation

Documentation is always evolving! Help by:

  • Fixing typos and unclear explanations
  • Adding examples and use cases
  • Improving configuration guides
  • Translating docs
🖥️

Add Compositor Support

Expand Wayland ecosystem compatibility by:

  • Testing on different compositors
  • Implementing support for new ones
  • Documenting quirks and workarounds

Getting Started

Ready to contribute? Here's how to get started:

1

Fork the Repository

Head over to the Stasis GitHub repo and fork it to your account.

2

Clone Your Fork

git clone https://github.com/YOUR_USERNAME/stasis.git
cd stasis
3

Create a Branch

git checkout -b feature/your-feature-name
4

Make Your Changes

Write clear, well-commented code. Test your changes thoroughly before submitting.

5

Submit a Pull Request

Push your branch and open a PR on GitHub. Describe what you've changed and why.

💬 Questions?

Don't hesitate to ask! Join the Discord community or open a discussion on GitHub. We're a friendly bunch and happy to help newcomers!