Skip to content

Commit 03abf2f

Browse files
committed
Update GitHub issue and contributing templates.
[skip ci]
1 parent 6f27ded commit 03abf2f

File tree

2 files changed

+16
-9
lines changed

2 files changed

+16
-9
lines changed

.github/CONTRIBUTING.md

Lines changed: 13 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,22 +1,27 @@
11
Contributing
22
-------------
33

4-
Before you contribute code to php-telegram-bot, please make sure it conforms to the PSR-2 coding standard and that the php-telegram-bot unit tests still pass. The easiest way to contribute is to work on a checkout of the repository, or your own fork. If you do this, you can run the following commands to check if everything is ready to submit:
4+
The easiest way to contribute is to work on a checkout of your own fork.
5+
When working on the `core` repository, it makes sense to rename your fork to `php-telegram-bot`.
6+
7+
Before you contribute code, please make sure it conforms to the PSR-2 coding standard and that the unit tests still pass.
8+
You can run the following commands to check if everything is ready to submit:
59

610
cd php-telegram-bot
711
composer install
8-
./vendor/bin/phpcs --standard=phpcs.xml -sp --encoding=utf-8 src/ --report-width=150
12+
composer check-code
913

10-
Which should give you no output, indicating that there are no coding standard errors. And then:
14+
Which should give you no output, indicating that there are no coding standard errors.
15+
And then (remember to set up your test database!):
1116

12-
./vendor/bin/phpunit
17+
composer test
1318

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

1621
Pushing
1722
-------
1823

19-
Development is based on the git flow branching model (see http://nvie.com/posts/a-successful-git-branching-model/ )
24+
Development is based on the git flow branching model (see http://nvie.com/posts/a-successful-git-branching-model/)
2025
If you fix a bug please push in hotfix branch.
2126
If you develop a new feature please create a new branch.
2227

@@ -30,8 +35,8 @@ Further code convention adopted
3035

3136
- Each method and class is documented with a docblock
3237

33-
Example for a function or methods:
34-
```
38+
Example for a function or method:
39+
```php
3540
/**
3641
* Get formatted date
3742
*
@@ -42,7 +47,7 @@ Example for a function or methods:
4247
```
4348

4449
- Each file is provided with the following header:
45-
```
50+
```php
4651
/**
4752
* This file is part of the TelegramBot package.
4853
*

.github/ISSUE_TEMPLATE.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,10 @@
11
### Required Information
2-
2+
<!-- Please enter exact version numbers! -->
3+
- Operating system:
34
- PHP version:
45
- PHP Telegram Bot version:
56
- Using MySQL database: yes / no
7+
- MySQL version:
68
- Update Method: Webhook / getUpdates
79
- Self-signed certificate: yes / no
810
- RAW update (if available):

0 commit comments

Comments
 (0)