Skip to content

Commit 683aa1a

Browse files
noplanmannoplanman
committed
Create custom issue templates, to make reporting issues easier for users and us.
1 parent 6aa29b4 commit 683aa1a

File tree

7 files changed

+177
-42
lines changed

7 files changed

+177
-42
lines changed

Diff for: ‎.github/ISSUE_TEMPLATE.md

-26
This file was deleted.

Diff for: ‎.github/ISSUE_TEMPLATE/BC_Break.md

+55
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,55 @@
1+
---
2+
name: 💥 BC Break
3+
about: Have you encountered an issue during an upgrade? 💣
4+
---
5+
6+
<!--
7+
Before reporting a BC break, please consult the changelog and wiki entry for the particular version to make sure it's not an expected change:
8+
- https://github.com/php-telegram-bot/core/blob/master/CHANGELOG.md
9+
- https://github.com/php-telegram-bot/core/wiki/Breaking-backwards-compatibility
10+
-->
11+
12+
### BC Break Report
13+
14+
<--
15+
❗ NEVER put your Telegram API key or any other private details here. (like passwords, user IDs, etc.)
16+
Substitute them like <API_KEY> or <USER_ID> etc.
17+
-->
18+
19+
#### Required Information
20+
21+
<!-- Fill in the relevant information below to help triage your pull request. -->
22+
<!-- Please enter exact version numbers, not just "latest" etc.! -->
23+
24+
| ? | !
25+
| --- | ---
26+
| Operating system | Name and version
27+
| PHP Telegram Bot version | x.y.z
28+
| PHP version | x.y.z
29+
| MySQL version | x.y.z / none
30+
| Update Method | Webhook / getUpdates
31+
| Self-signed certificate | yes / no
32+
| RAW update (if available) | `{...}`
33+
34+
#### Summary
35+
36+
<!-- Provide a summary describing the problem you are experiencing. -->
37+
38+
#### Previous behaviour
39+
40+
<!-- What was the previous (working) behaviour? -->
41+
42+
#### Current behaviour
43+
44+
<!-- What is the current (broken) behaviour? -->
45+
46+
#### How to reproduce
47+
48+
<!--
49+
Provide steps to reproduce the bug.
50+
If possible, also add any relevant code snippet.
51+
-->
52+
53+
#### Expected behaviour
54+
55+
<!-- What was the expected (correct) behaviour? -->

Diff for: ‎.github/ISSUE_TEMPLATE/Bug.md

+45
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,45 @@
1+
---
2+
name: 🐞 Bug Report
3+
about: Something is broken? 🔨
4+
---
5+
6+
### Bug Report
7+
8+
<--
9+
❗ NEVER put your Telegram API key or any other private details here. (like passwords, user IDs, etc.)
10+
Substitute them like <API_KEY> or <USER_ID> etc.
11+
-->
12+
13+
#### Required Information
14+
15+
<!-- Fill in the relevant information below to help triage your pull request. -->
16+
<!-- Please enter exact version numbers, not just "latest" etc.! -->
17+
18+
| ? | !
19+
| --- | ---
20+
| Operating system | Name and version
21+
| PHP Telegram Bot version | x.y.z
22+
| PHP version | x.y.z
23+
| MySQL version | x.y.z / none
24+
| Update Method | Webhook / getUpdates
25+
| Self-signed certificate | yes / no
26+
| RAW update (if available) | `{...}`
27+
28+
#### Summary
29+
30+
<!-- Provide a summary describing the problem you are experiencing. -->
31+
32+
### Current behaviour
33+
34+
<!-- What is the current (buggy) behaviour? -->
35+
36+
#### How to reproduce
37+
38+
<!--
39+
Provide steps to reproduce the bug.
40+
If possible, also add any relevant code snippet.
41+
-->
42+
43+
#### Expected behaviour
44+
45+
<!-- What was the expected (correct) behaviour? -->

Diff for: ‎.github/ISSUE_TEMPLATE/Feature_Request.md

+10
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
---
2+
name: 🎉 Feature Request
3+
about: You have a neat idea that should be implemented? 🎩
4+
---
5+
6+
### Feature Request
7+
8+
#### Summary
9+
10+
<!-- Provide a summary of the feature you would like to see implemented. -->

Diff for: ‎.github/ISSUE_TEMPLATE/Support_Question.md

+37
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,37 @@
1+
---
2+
name: ❓ Support Question
3+
about: Have a problem that you can't figure out? 🤔
4+
---
5+
6+
### Support Question
7+
8+
<!--
9+
Before asking a question here, please try asking in the support group first.
10+
https://telegram.me/PHP_Telegram_Bot_Support
11+
12+
Keep in mind that GitHub is primarily an issue tracker.
13+
-->
14+
15+
<--
16+
❗ NEVER put your Telegram API key or any other private details here. (like passwords, user IDs, etc.)
17+
Substitute them like <API_KEY> or <USER_ID> etc.
18+
-->
19+
20+
#### Required Information
21+
22+
<!-- Fill in the relevant information below to help triage your pull request. -->
23+
<!-- Please enter exact version numbers, not just "latest" etc.! -->
24+
25+
| ? | !
26+
| --- | ---
27+
| Operating system | Name and version
28+
| PHP Telegram Bot version | x.y.z
29+
| PHP version | x.y.z
30+
| MySQL version | x.y.z / none
31+
| Update Method | Webhook / getUpdates
32+
| Self-signed certificate | yes / no
33+
| RAW update (if available) | `{...}`
34+
35+
#### Summary
36+
37+
<!-- Describe the issue you are facing here. -->

Diff for: ‎.github/PULL_REQUEST_TEMPLATE.md

+17-3
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,19 @@
1-
<!-- Important: If this pull request is not related to any issue and contains a new feature, please create an issue first for discussion. -->
1+
<!--
2+
Important:
3+
If this pull request is not related to any issue and contains a new feature, please create an issue first for discussion.
4+
https://github.com/php-telegram-bot/core/issues/new?template=Feature_Request.md
25
3-
<!-- Make sure this pull request is pointed towards the "develop" branch and refers to any issue that it's related to! -->
6+
Make sure this pull request is pointed towards the "develop" branch and refers to any issue that it's related to!
7+
-->
48

5-
<!-- Explain in detail what this pull request contains. -->
9+
<!-- Fill in the relevant information below to help triage your pull request. -->
10+
11+
| ? | !
12+
|--- | ---
13+
| Type | bug / feature / improvement
14+
| BC Break | yes / no
15+
| Fixed issues | <!-- use #NUM format to reference an issue -->
16+
17+
#### Summary
18+
19+
<!-- Provide a summary of your change. -->

Diff for: ‎.github/CONTRIBUTING.md renamed to ‎CONTRIBUTING.md

+13-13
Original file line numberDiff line numberDiff line change
@@ -1,37 +1,37 @@
1-
Contributing
2-
-------------
1+
# Contributing
32

43
The easiest way to contribute is to work on a checkout of your own fork.
54
When working on the `core` repository, it makes sense to rename your fork to `php-telegram-bot`.
65

7-
Before you contribute code, please make sure it conforms to the PSR-2 coding standard and that the unit tests still pass.
6+
Before you contribute code, please make sure it conforms to the PSR-12 coding standard and that the unit tests still pass.
87
You can run the following commands to check if everything is ready to submit:
98

10-
cd php-telegram-bot
11-
composer install
12-
composer check-code
9+
```bash
10+
cd php-telegram-bot
11+
composer install
12+
composer check-code
13+
```
1314

1415
Which should give you no output, indicating that there are no coding standard errors.
1516
And then (remember to set up your test database!):
1617

17-
composer test
18+
```bash
19+
composer test
20+
```
1821

1922
Which should give you no failures or errors. You can ignore any skipped tests as these are for external tools.
2023

21-
Pushing
22-
-------
24+
## Pushing
2325

2426
Development is based on the git flow branching model (see http://nvie.com/posts/a-successful-git-branching-model/)
2527
If you fix a bug please push in hotfix branch.
2628
If you develop a new feature please create a new branch.
2729

28-
Version
29-
-------
30+
## Version
3031

3132
Version number: 0.#version.#hotfix
3233

33-
Further code convention adopted
34-
-------------------------------
34+
## Further code convention adopted
3535

3636
- Each method and class is documented with a docblock
3737

0 commit comments

Comments
 (0)