Skip to main content

Contributing

██████╗  █████╗ ███╗   ██╗██╗  ██╗    ██╗     ██╗███╗   ██╗██╗   ██╗██╗  ██╗
██╔══██╗██╔══██╗████╗  ██║██║ ██╔╝    ██║     ██║████╗  ██║██║   ██║╚██╗██╔╝
██║  ██║███████║██╔██╗ ██║█████╔╝     ██║     ██║██╔██╗ ██║██║   ██║ ╚███╔╝
██║  ██║██╔══██║██║╚██╗██║██╔═██╗     ██║     ██║██║╚██╗██║██║   ██║ ██╔██╗
██████╔╝██║  ██║██║ ╚████║██║  ██╗    ███████╗██║██║ ╚████║╚██████╔╝██╔╝ ██╗
╚═════╝ ╚═╝  ╚═╝╚═╝  ╚═══╝╚═╝  ╚═╝    ╚══════╝╚═╝╚═╝  ╚═══╝ ╚═════╝ ╚═╝  ╚═╝

How to Contribute​

Reporting Issues​

Found a bug or have a feature request? Please open an issue on the relevant repository:

Pull Requests​

  1. Fork the repository
  2. Create a feature branch: git checkout -b feature/my-feature
  3. Make your changes
  4. Test thoroughly
  5. Commit with clear messages: git commit -m "<component/area>: new feature description"
  6. Push to your fork: git push origin feature/my-feature
  7. Open a Pull Request

Code Style​

  • Go: Follow standard Go formatting (go fmt, make fmt)
    • Include appropriate test coverage
    • Fix lint errors golangci-lint run
  • TypeScript/JavaScript: Use consistent formatting
  • Documentation: Use clear, concise language

Community Guidelines​

Be respectful on all forums such as GitHub discussions, discord, etc.

  • Be respectful and inclusive
  • Help others when you can
  • Document your code
  • Keep discussions on-topic

Support the Project​

Want to support Dank Linux development? Consider tipping us:

Tip on Ko-fi 🥃

Contributions of any kind - code, documentation, bug reports, or monetary - are all appreciated!

License​

All Dank Linux projects are licensed under the MIT License. By contributing, you agree to license your contributions under the same license.

Getting Help​

  • Discord: DankMaterialShell has a subsection on the niri discord server, keep relevant discussions in the relevant #dms-* channels.
  • GitHub Discussions: Ask questions and share ideas
  • Documentation: Check these docs first