|
| 1 | +# How to contribute |
| 2 | + |
| 3 | +## Questions and issues |
| 4 | + |
| 5 | +If you have a question about or a general issue while using this library, |
| 6 | +head over to the [discussions section](https://github.com/chillerlan/php-oauth-core/discussions), |
| 7 | +create a new post and describe your issue as precise as possible, ideally add a code example (if applicable). |
| 8 | +Please don't just write "headline says all" because the reply will likely be similarly concise - help me (and others) help you! |
| 9 | +(just to clarify: the "general" does not mean general PHP support, in which case you're better off on |
| 10 | +[StackOverflow](https://stackoverflow.com/questions/tagged/php) or [/r/PHPhelp](https://www.reddit.com/r/PHPhelp/)) |
| 11 | + |
| 12 | + |
| 13 | +## Bug reports |
| 14 | + |
| 15 | +So you found a bug or the library code is somehow misbehaving? That's great (well, not that great tho). In that case, |
| 16 | +please [open a bug report and FILL OUT THE ISSUE TEMPLATE](https://github.com/chillerlan/php-oauth-core/issues/new?assignees=&labels=bug&projects=&template=bug_report.md&title=%5BBUG%5D) |
| 17 | +(i have to write that in all caps because nobody actually does it which usually leads to several avoidable follow-up questions that cost both of us precious time). |
| 18 | +Below an example of the bug report template (it's not that hard): |
| 19 | + |
| 20 | +**Describe the bug** |
| 21 | + |
| 22 | +A clear and concise description of what the bug is. |
| 23 | + |
| 24 | +**Steps to reproduce the behavior** |
| 25 | +- When i do ... |
| 26 | +- The code below ... |
| 27 | +- Error message: ... |
| 28 | + |
| 29 | +**Code sample** |
| 30 | +```php |
| 31 | +// your code here |
| 32 | +``` |
| 33 | + |
| 34 | +**Expected behavior** |
| 35 | + |
| 36 | +A clear and concise description of what you expected to happen. |
| 37 | + |
| 38 | +**Screenshots** |
| 39 | + |
| 40 | +If applicable, add screenshots to help explain your problem. |
| 41 | + |
| 42 | +**Environment (please complete the following information):** |
| 43 | +- PHP version/OS: [e.g. 7.4.12, Ubuntu 20.04] |
| 44 | +- Library version: [e.g. 4.0.0] |
| 45 | + |
| 46 | +**Additional context** |
| 47 | + |
| 48 | +Add any other useful context about the problem. |
| 49 | + |
| 50 | + |
| 51 | +## Pull requests and bug fixes |
| 52 | + |
| 53 | +You want to contribute code to fix something or add a feature? Hey that's cool! However, there's a few things to keep in mind: |
| 54 | + |
| 55 | +- Please add a description of what the PR does or fixes and why it should be merged. If you're unsure, [open an issue](https://github.com/chillerlan/php-oauth-core/issues/new?assignees=&labels=enhancement&projects=&template=feature_request.md&title=%5BENHANCEMENT%5D) before to gather feedback. |
| 56 | +- Make sure your branch is up-to-date/even with the upstream branch you're submitting your PR to. |
| 57 | +- Please try to adhere to the [*loosely outlined* coding standards](https://github.com/chillerlan/php-qrcode/discussions/60), or, in case you're using [PHPStorm](https://www.jetbrains.com/phpstorm/), make sure you're using [the supplied IDE profile](https://github.com/chillerlan/php-oauth-core/tree/main/.idea). |
| 58 | + |
| 59 | + |
| 60 | +## Documentation |
| 61 | + |
| 62 | +The documentation is a work in progress - any suggestion and contribution is very welcome! |
| 63 | +If you have an addition or correction, feel free to open a [documentation issue](https://github.com/chillerlan/php-oauth-core/issues/new?assignees=&labels=docs&projects=&template=documentation.md&title=%5BDOCS%5D). |
| 64 | + |
| 65 | + |
| 66 | +The API documentation is auto generated with [phpDocumentor](https://www.phpdoc.org/) from the docblocks [in the PHP sources](https://github.com/chillerlan/php-oauth-core/tree/main/src). |
| 67 | +The markdown sources for the [Read the Docs online manual](https://php-oauth.readthedocs.io) are located in the [/docs directory](https://github.com/chillerlan/php-oauth-core/tree/main/docs) |
0 commit comments