Edit contributing guidelines

ynjw · Aug 22, 2023 · ef6b7b9 · ef6b7b9
1 parent d97551e
commit ef6b7b9
Show file tree

Hide file tree

Showing 2 changed files with 23 additions and 6 deletions.
diff --git a/CONTRIBUTING.md → docs/CONTRIBUTING.md b/CONTRIBUTING.md → docs/CONTRIBUTING.md
@@ -12,25 +12,33 @@ Please take following steps to open an issue.
 
 - 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.
+- Add __probe.log__ and __operation.log__. A video clip is not so helpful because it will not give information on what is happening internally.
 
-- <ins>Be prepared to respond to a request after opening an issue.</ins> It is merely a startig point and you will be requested to provide additional information in most cases.
+- An issue which includes no meaningful clue CAN BE CLOSED on sight.
+
+- <ins>Be prepared to respond to a request after opening an issue.</ins> It is just a starting point and in most cases, you will be requested to provide additional information.
+
+- <ins>Avoid posting a comment by email.</ins> It will produce a lot of garbage and make it hard to read.
 
 ## 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 don't 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.
+- 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.
 
 - Search [Issues](https://github.com/emoacht/Monitorian/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.
 
-- <ins>Be prepared to respond to a request after opening a feature request or suggestion.</ins> It is merely a starting point and you will be requested to provide additional information in most cases.
+-  A feature request or suggestion which is the same as already discussed CAN BE CLOSED on sight.
+
+- <ins>Be prepared to respond to a request after opening a feature request or suggestion.</ins> It is just a starting point and in most cases, you will be requested to provide additional information.
+
+- <ins>Avoid posting a comment by email.</ins> It will produce a lot of garbage and make it hard to read.
 
 ## 3. Pull requests
 
@@ -43,4 +51,4 @@ Please take following points into account to open a feature request or suggestio
 ### 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#.
+- It is recommended to use the latest features of C#.
diff --git a/docs/TEMPLATE.md b/docs/TEMPLATE.md
@@ -0,0 +1,9 @@
+## Message Template
+
+```
+Could you read [Contributing Guidelines](https://github.com/emoacht/Monitorian/blob/9aeb4238af22c60ccc03051f144edd1a5ee9acdb/CONTRIBUTING.md)?
+```
+
+```
+Could you read [Contributing Guidelines](https://github.com/emoacht/Monitorian/blob/9aeb4238af22c60ccc03051f144edd1a5ee9acdb/CONTRIBUTING.md) and post __probe.log__ and __operation.log__? How to produce these logs is explained in [Reporting](https://github.com/emoacht/Monitorian#reporting) in readme.
+```