Contributing to Monitorian

March 22, 2026 ยท View on GitHub

Thanks to your interest in contributing to this project.

1. General

  • Read through readme before posting. Avoid asking questions that are already covered in readme.

  • Be prepared to respond to any request after opening an issue, request or suggestion. In most cases, you will be requested to provide additional information.

  • Do not send a comment by email. It will produce a lot of garbage and make it hard to read.

2. Issues

  • Check Detection of external monitors and Reporting.

  • Search Issues to date. To search open and closed issues at once, remove is:open from default syntax in Filters box and use only is:issue syntax.

  • Include all information necessary for a reader who has no knowledge about your monitor or other devices to understand and reproduce the issue.

  • Add probe.log and operation.log. A video clip is not very helpful because it will not provide information about what is happening internally.

  • An issue which includes no meaningful clue CAN BE CLOSED without review.

3. Feature requests or suggestions

  • Do not open feature requests or suggestions in Ideas of Discussions in this project. This is for aggregating them in Issues.

  • Search Issues to date.

  • This app's main focus and competence is brightness of monitors. This app uses DDC/CI for this purpose, and not vice versa. The importance for keeping focused cannot be overemphasized.

  • Explain the necessity and added value of the feature. Describe how it would be useful in real-world scenarios or use cases. An existing feature of other apps is not a sufficient reason to include the same to this app.

  • Include technical information to implement the feature as much as possible. A feature which is not technically feasible cannot be added anyways.

  • A feature request or suggestion which is the same as already discussed CAN BE CLOSED without review.

4. Pull requests

4.1 PR for language

  • Read Globalization in readme.
  • Use phrases used by the OS as much as possible.
  • Do not try to explain everything. You cannot create a flawless expression in a short sentence like menu item.
  • Do not edit the readme.

4.2 PR for functionality

  • Open an issue and get agreement for your proposed change before starting your work.
  • Split the changes into dedicated commits based on their reasons and objectives. Avoid adding unrelated changes into a commit.
  • It is recommended to use the latest features of C#, provided that they are supported in this project.