Skip to content

Commit ef6b7b9

Browse files
committed
Edit contributing guidelines
1 parent d97551e commit ef6b7b9

File tree

2 files changed

+23
-6
lines changed

2 files changed

+23
-6
lines changed

CONTRIBUTING.md renamed to docs/CONTRIBUTING.md

Lines changed: 14 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -12,25 +12,33 @@ Please take following steps to open an issue.
1212

1313
- 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.
1414

15-
- Add logs. A video clip is not so helpful because it will not give information on what is happening internally.
15+
- Add __probe.log__ and __operation.log__. A video clip is not so helpful because it will not give information on what is happening internally.
1616

17-
- <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.
17+
- An issue which includes no meaningful clue CAN BE CLOSED on sight.
18+
19+
- <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.
20+
21+
- <ins>Avoid posting a comment by email.</ins> It will produce a lot of garbage and make it hard to read.
1822

1923
## 2. Feature requests or suggestions
2024

21-
Do not open feature requests or suggestions in __Ideas__ of __Discussions__ in this project. It is for aggregating them in __Issues__.
25+
Please don't open feature requests or suggestions in __Ideas__ of __Discussions__ in this project. It is for aggregating them in __Issues__.
2226

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

25-
- 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.
29+
- 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.
2630

2731
- Search [Issues](https://github.com/emoacht/Monitorian/issues) to date.
2832

2933
- 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.
3034

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

33-
- <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.
37+
- A feature request or suggestion which is the same as already discussed CAN BE CLOSED on sight.
38+
39+
- <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.
40+
41+
- <ins>Avoid posting a comment by email.</ins> It will produce a lot of garbage and make it hard to read.
3442

3543
## 3. Pull requests
3644

@@ -43,4 +51,4 @@ Please take following points into account to open a feature request or suggestio
4351
### 3.2 PR for functionality
4452

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

docs/TEMPLATE.md

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
## Message Template
2+
3+
```
4+
Could you read [Contributing Guidelines](https://github.com/emoacht/Monitorian/blob/9aeb4238af22c60ccc03051f144edd1a5ee9acdb/CONTRIBUTING.md)?
5+
```
6+
7+
```
8+
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.
9+
```

0 commit comments

Comments
 (0)