How to contribute
We want to encourage users and developers to give active feedback on their experience and feel free to contribute.
First, we feel very strongly about being inclusive and respectful to other contributors. Please follow the Python Community guidelines if you wish to contribute to our project.
There are different ways you can contribute:
If you encounter a bug, you can directly report it in the issues section. Please describe how to reproduce the bug and include as much information as possible that can be helpful for fixing it.
Have you written code that fixes the bug? You can open a new pull request or include your suggested fix in the issue.
We would like to hear about your experience when using ImSwitch and suggestions for improvement. You can do that by starting a thread in the discussion section on GitHub.
Suggest a new feature
If you are missing features and want to develop ImSwitch further, you can start a discussion and brainstorm your suggestions. Feel free to open a pull request, but we believe it’s essential to have feedback from the community if you want to add new functionality.
We would like to include your use-case into the documentation! Feel free to open a discussion thread about what you wish to include or improve.
Adding device support
See this page for information on adding support for new devices. You can start a discussion if you want to get advice and help to get started.
We want to keep including automated tests into the development process, so if you have contributed to the project by fixing a bug or providing new functionality, we encourage you to write code that tests your contribution as well.
ImSwitch’s pytests are located inside the
_test/ui/ folders under each ImSwitch module’s directory.
So if you have added a new widget to the hardware control module and want to write UI tests for it,
you should place the UI test files in the
The test suite will automatically be run on commits and pull requests on GitHub.
You can also run it manually by executing the command
python -m pytest --pyargs imswitch in the root directory of the repository.