Skip to content

Latest commit

 

History

History
46 lines (25 loc) · 2.5 KB

CONTRIBUTING.md

File metadata and controls

46 lines (25 loc) · 2.5 KB

Contributing to Monitorian

Thanks to your interest in contributing to this project.

1. Issues

Please take following steps to open an issue.

  • Read through Detection of external monitors and Reporting in readme.

  • 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 the issue. Include how to reproduce the issue as well.

  • Add logs. A video clip is not so helpful because it will not give information on what is happening internally.

  • Be prepared to respond to a request after opening an issue. It is merely a startig point and you will be requested to provide additional information in most cases.

2. Feature requests or suggestions

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

Please take following points into account to open a feature request or suggestion.

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

  • Search Issues to date.

  • Explain the necessity and added value of the feature. Describe how the feature could be useful in actual use cases or scenarios. An existing feature of other app will not be reason for adding 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.

  • Be prepared to respond to a request after opening a feature request or suggestion. It is merely a starting point and you will be requested to provide additional information in most cases.

3. Pull requests

3.1 PR for language

  • Read Globalization in readme.
  • Use a phrase 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.

3.2 PR for functionality

  • Open an issue and get agreement for your proposed change before starting your work.
  • It is recommended to use the latest features of C#.