Skip to content

Commit cf0648e

Browse files
committed
🛀 doc cleanup
1 parent 17733e7 commit cf0648e

18 files changed

+546
-86
lines changed

docs/Appendix/Contribute.md

Lines changed: 66 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,66 @@
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-qrcode/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-qrcode/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.3.4]
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-qrcode/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-qrcode/tree/main/.idea).
58+
59+
60+
## Documentation
61+
62+
The documentation is a work in progress - any suggestion and contribution is very welcome!
63+
64+
65+
The API documentation is auto generated with [phpDocumentor](https://www.phpdoc.org/) from the docblocks [in the PHP sources](https://github.com/chillerlan/php-qrcode/tree/main/src).
66+
The markdown sources for the [Read the Docs online manual](https://php-qrcode.readthedocs.io) are located in the [/docs directory](https://github.com/chillerlan/php-qrcode/tree/main/docs)
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.

docs/Built-In-Output-QRMarkupHTML.md renamed to docs/Built-In-Output/QRMarkupHTML.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
[Class `QRMarkupHTML`](https://github.com/chillerlan/php-qrcode/blob/main/src/Output/QRMarkupHTML.php): HTML output
44

55
This class is a cheap markup substitute for when SVG is not available or not an option (which was an issue before ca 2012).
6-
As a general rule: if you plan to display the QR Code in a web browser, you should be using the [SVG output](./Built-In-Output-QRMarkupSVG.md).
6+
As a general rule: if you plan to display the QR Code in a web browser, you should be using the [SVG output](../Built-In-Output/QRMarkupSVG.md).
77

88

99
## Example
File renamed without changes.

0 commit comments

Comments
 (0)