This repository has been archived by the owner on Mar 23, 2024. It is now read-only.
-
-
Notifications
You must be signed in to change notification settings - Fork 1
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
8fbdf6b
commit 33a7281
Showing
8 changed files
with
865 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,31 @@ | ||
# Read the Docs configuration file for Sphinx projects | ||
# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details | ||
|
||
# Required | ||
version: 2 | ||
|
||
# Set the OS, Python version and other tools you might need | ||
build: | ||
os: ubuntu-22.04 | ||
tools: | ||
python: "3.11" | ||
# You can also specify other tool versions: | ||
# nodejs: "19" | ||
# rust: "1.64" | ||
# golang: "1.19" | ||
|
||
# Build documentation in the "docs/" directory with Sphinx | ||
sphinx: | ||
configuration: docs/conf.py | ||
|
||
# Optionally build your docs in additional formats such as PDF and ePub | ||
# formats: | ||
# - epub | ||
|
||
# Optional but recommended, declare the Python requirements required | ||
# to build your documentation | ||
# See https://docs.readthedocs.io/en/stable/guides/reproducible-builds.html | ||
python: | ||
install: | ||
- requirements: docs/requirements.txt |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,67 @@ | ||
# How to contribute | ||
|
||
## Questions and issues | ||
|
||
If you have a question about or a general issue while using this library, | ||
head over to the [discussions section](https://github.com/chillerlan/php-oauth-core/discussions), | ||
create a new post and describe your issue as precise as possible, ideally add a code example (if applicable). | ||
Please don't just write "headline says all" because the reply will likely be similarly concise - help me (and others) help you! | ||
(just to clarify: the "general" does not mean general PHP support, in which case you're better off on | ||
[StackOverflow](https://stackoverflow.com/questions/tagged/php) or [/r/PHPhelp](https://www.reddit.com/r/PHPhelp/)) | ||
|
||
|
||
## Bug reports | ||
|
||
So you found a bug or the library code is somehow misbehaving? That's great (well, not that great tho). In that case, | ||
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) | ||
(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). | ||
Below an example of the bug report template (it's not that hard): | ||
|
||
**Describe the bug** | ||
|
||
A clear and concise description of what the bug is. | ||
|
||
**Steps to reproduce the behavior** | ||
- When i do ... | ||
- The code below ... | ||
- Error message: ... | ||
|
||
**Code sample** | ||
```php | ||
// your code here | ||
``` | ||
|
||
**Expected behavior** | ||
|
||
A clear and concise description of what you expected to happen. | ||
|
||
**Screenshots** | ||
|
||
If applicable, add screenshots to help explain your problem. | ||
|
||
**Environment (please complete the following information):** | ||
- PHP version/OS: [e.g. 7.4.12, Ubuntu 20.04] | ||
- Library version: [e.g. 4.0.0] | ||
|
||
**Additional context** | ||
|
||
Add any other useful context about the problem. | ||
|
||
|
||
## Pull requests and bug fixes | ||
|
||
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: | ||
|
||
- 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. | ||
- Make sure your branch is up-to-date/even with the upstream branch you're submitting your PR to. | ||
- 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). | ||
|
||
|
||
## Documentation | ||
|
||
The documentation is a work in progress - any suggestion and contribution is very welcome! | ||
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). | ||
|
||
|
||
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). | ||
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) |
Oops, something went wrong.