Skip to content

Contributing to streamdeck linux gui

Looking for a useful open source project to contribute to? Want your contributions to be warmly welcomed and acknowledged? Welcome! You have found the right place.

Getting streamdeck_ui set up for local development

The first step when contributing to any project is getting it set up on your local machine. streamdeck_ui aims to make this as simple as possible.

Account Requirements:

Base System Requirements:

  • Python 3.8+
  • Poetry
  • Bash or a bash-compatible shell (should be auto-installed on Linux/Mac)

Once you have verified that your system matches the base requirements, you can start getting the project working by following these steps:

  1. Fork the project on GitHub.
    • Make sure you untick the "copy the main branch only" option. This will ensure you have a full copy of the project to work with.
  2. Clone your fork to your local file system: git clone https://github.com/$GITHUB_ACCOUNT/streamdeck-linux-gui.git
  3. cd streamdeck_ui
  4. poetry install

Making a contribution

Congrats! You're now ready to make a contribution! Use the following as a guide to help you reach a successful pull request:

  1. Check the issues page or discussions on GitHub to see if the task you want to complete is listed there.
    • If it's listed there, write a comment letting others know you are working on it.
    • If it's not listed in GitHub issues or discussions, go ahead and log a new issue. Then add a comment letting everyone know you have it under control.
      • If you're not sure if it's something that is good for the main streamdeck_ui project and want immediate feedback, you can discuss it on Discord.
  2. Create an issue branch for your local work git checkout -b issue/$ISSUE-NUMBER origin/main.
  3. Do your magic here. You can use poetry run streamdeck to run the application while developing.
  4. Try to include tests for your code whenever possible.
  5. Ensure your code matches the HOPE-8 Coding Standard used by the project.
    • You can use the lint.sh script existing in the scripts directory: bash scripts/lint.sh. This will let you know if everything is okay before you commit it.
  6. Ensure all tests pass. You can use the test.sh script inside the scripts directory: bash scripts/test.sh.
  7. When committing your changes, please make sure you follow the Angular commit message format.
  8. Submit a pull request to the main project repository via GitHub.

Thanks for the contribution! It will be reviewed as soon as possible, and once accepted, your name will be added to the acknowledgments list :).

Thank you

I cannot tell you how thankful we are for the hard work done by streamdeck-linux-gui contributors like you.

Thank you!

The streamdeck-linux-gui users! :heart: