Skip to content

Commit c833f5f

Browse files
luchaosluchaos
committed
Initial commit
0 parents  commit c833f5f

File tree

12 files changed

+414
-0
lines changed

12 files changed

+414
-0
lines changed

‎.editorconfig‎

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
root = true
2+
3+
[*]
4+
charset = utf-8
5+
end_of_line = lf
6+
insert_final_newline = true
7+
indent_style = space
8+
indent_size = 4
9+
trim_trailing_whitespace = true
10+
11+
[*.md]
12+
trim_trailing_whitespace = false
13+
14+
[*.{yml,yaml,neon,rc}]
15+
indent_size = 2

‎.gitattributes‎

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
# Path-based git attributes
2+
# https://www.kernel.org/pub/software/scm/git/docs/gitattributes.html
3+
4+
# Ignore all test and documentation with "export-ignore".
5+
/.github export-ignore
6+
/.gitattributes export-ignore
7+
/.gitignore export-ignore
8+
/phpunit.xml.dist export-ignore
9+
/art export-ignore
10+
/docs export-ignore
11+
/tests export-ignore
12+
/workbench export-ignore
13+
/.editorconfig export-ignore
14+
/.php_cs.dist.php export-ignore
15+
/psalm.xml export-ignore
16+
/psalm.xml.dist export-ignore
17+
/testbench.yaml export-ignore
18+
/UPGRADING.md export-ignore
19+
/phpstan.neon.dist export-ignore
20+
/phpstan-baseline.neon export-ignore

‎.github/ISSUE_TEMPLATE/config.yml‎

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
blank_issues_enabled: false
2+
contact_links:
3+
- name: Ask a question
4+
url: https://github.com/RetroAchievements/api-php/discussions/new?category=q-a
5+
about: Ask the community for help
6+
- name: Request a feature
7+
url: https://github.com/RetroAchievements/api-php/discussions/new?category=ideas
8+
about: Share ideas for new features
9+
- name: Report a bug
10+
url: https://github.com/RetroAchievements/api-php/issues/new
11+
about: Report a reproducable bug

‎.gitignore‎

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
.idea
2+
.phpunit.cache
3+
build
4+
composer.lock
5+
coverage
6+
docs
7+
phpunit.xml
8+
phpstan.neon
9+
testbench.yaml
10+
vendor
11+
node_modules

‎CODE_OF_CONDUCT.md‎

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
## Code of Conduct
2+
3+
Please review and abide by the [Code of Conduct](https://docs.retroachievements.org/Users-Code-of-Conduct/).

‎CONTRIBUTING.md‎

Lines changed: 42 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,42 @@
1+
# Contributing
2+
3+
Please read and understand the contribution guide before creating an issue or pull request.
4+
5+
## Etiquette
6+
7+
It's the duty of the maintainer to ensure that all submissions to the project are of sufficient quality to benefit the
8+
project. Many developers have different skills, strengths, and weaknesses. Respect the maintainer's decision, and do
9+
not be upset or abusive if your submission will not be used.
10+
11+
## Viability
12+
13+
When requesting or submitting new features, first consider whether it might be useful to others. Think about whether
14+
your feature is likely to be used by other users of the project.
15+
16+
## Procedure
17+
18+
Before filing an issue:
19+
20+
- Attempt to replicate the problem, to ensure that it wasn't a coincidental incident.
21+
- Check to make sure your feature suggestion isn't already present within the project.
22+
- Check the pull requests tab to ensure that the bug doesn't have a fix in progress.
23+
- Check the pull requests tab to ensure that the feature isn't already in progress.
24+
25+
Before submitting a pull request:
26+
27+
- Check the codebase to ensure that your feature doesn't already exist.
28+
- Check the pull requests to ensure that another person hasn't already submitted the feature or fix.
29+
30+
## Requirements
31+
32+
- **Follow existing code style** - Run `composer fix` to fix most code style issues automatically.
33+
34+
- **Add tests!** - Your patch won't be accepted if it doesn't have tests.
35+
36+
- **Document any change in behaviour** - Make sure the `README.md` and any other relevant documentation are up to date.
37+
38+
- **Consider our release cycle** - We try to follow [SemVer v2.0.0](https://semver.org/). Randomly breaking public APIs is not an option.
39+
40+
- **One pull request per feature** - If you want to do more than one thing, send multiple pull requests.
41+
42+
- **Send coherent history** - Make sure each individual commit in your pull request is meaningful. If you had to make multiple intermediate commits while developing, please [squash them](https://www.git-scm.com/book/en/v2/Git-Tools-Rewriting-History#Changing-Multiple-Commit-Messages) before submitting.

‎LICENSE.md‎

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
MIT License
2+
3+
Copyright (c) 2024 RetroAchievements.org
4+
5+
Permission is hereby granted, free of charge, to any person obtaining a copy
6+
of this software and associated documentation files (the "Software"), to deal
7+
in the Software without restriction, including without limitation the rights
8+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9+
copies of the Software, and to permit persons to whom the Software is
10+
furnished to do so, subject to the following conditions:
11+
12+
The above copyright notice and this permission notice shall be included in all
13+
copies or substantial portions of the Software.
14+
15+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21+
SOFTWARE.

‎README.md‎

Lines changed: 41 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,41 @@
1+
<p align="center" dir="auto"><a href="https://retroachievements.org" rel="nofollow"><img src="https://raw.githubusercontent.com/RetroAchievements/RAWeb/master/public/assets/images/ra-icon.webp" width="200" alt="RetroAchievements Logo" style="max-width: 100%;"></a></p>
2+
<h1 align="center">RetroAchievements Web API Client</h1>
3+
4+
[![Latest Version on Packagist](https://img.shields.io/packagist/v/retroachievements/api.svg?style=flat-square)](https://packagist.org/packages/retroachievements/api)
5+
[![GitHub Tests Action Status](https://img.shields.io/github/actions/workflow/status/retroachievements/api/run-tests.yml?branch=main&label=tests&style=flat-square)](https://github.com/retroachievements/api/actions?query=workflow%3Arun-tests+branch%3Amain)
6+
[![GitHub Code Style Action Status](https://img.shields.io/github/actions/workflow/status/retroachievements/api/fix-php-code-style-issues.yml?branch=main&label=code%20style&style=flat-square)](https://github.com/retroachievements/api/actions?query=workflow%3A"Fix+PHP+code+style+issues"+branch%3Amain)
7+
[![Total Downloads](https://img.shields.io/packagist/dt/retroachievements/api.svg?style=flat-square)](https://packagist.org/packages/retroachievements/api)
8+
9+
## Installation
10+
11+
Install the package via composer:
12+
13+
```shell
14+
composer require retroachievements/api
15+
```
16+
17+
## Usage
18+
19+
WIP
20+
21+
## Testing
22+
23+
```shell
24+
composer test
25+
```
26+
27+
## Contributing
28+
29+
See [Contribution Guidelines](CONTRIBUTING.md) and [Code of Conduct](CODE_OF_CONDUCT.md).
30+
31+
## Security Vulnerabilities
32+
33+
Please review [our security policy](../../security/policy).
34+
35+
## Credits
36+
37+
- [All Contributors](../../contributors)
38+
39+
## License
40+
41+
MIT License (MIT). See [License File](LICENSE.md).

‎SECURITY.md‎

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
1+
# Security Policy
2+
3+
The RAWeb team takes the security of the RetroAchievements platform seriously. If you discover a security issue, we appreciate your help in disclosing it to us in a responsible manner.
4+
5+
## Reporting a Vulnerability
6+
7+
Here's how you can report a security issue:
8+
9+
1. **Do not report security issues in GitHub issues, discussions, or on Discord.**
10+
2. **Send a direct on-site message.** If you believe you've found a security vulnerability, [please send an on-site message to RAdmin](https://retroachievements.org/user/RAdmin).
11+
12+
In your report, please include:
13+
14+
- A brief description of the issue.
15+
- Steps to reproduce the issue, if possible.
16+
- Potential impact of the issue.
17+
18+
We will acknowledge your report within 48 hours of receiving it. We appreciate your help as we strive to keep our site as secure as possible. Thank you.

‎composer.json‎

Lines changed: 33 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,33 @@
1+
{
2+
"name": "retroachievements/api",
3+
"description": "RetroAchievements Web API Client",
4+
"type": "library",
5+
"keywords": [
6+
"RetroAchievmenets",
7+
"retro",
8+
"achievements",
9+
"API"
10+
],
11+
"homepage": "https://github.com/retroachievements/api-php",
12+
"license": "MIT",
13+
"require": {
14+
"php": "^8.2"
15+
},
16+
"require-dev": {},
17+
"minimum-stability": "dev",
18+
"prefer-stable": true,
19+
"config": {
20+
"sort-packages": true
21+
},
22+
"autoload": {
23+
"psr-4": {
24+
"RetroAchievements\\Api\\": "src"
25+
}
26+
},
27+
"autoload-dev": {
28+
"psr-4": {
29+
"Tests\\": "tests"
30+
}
31+
},
32+
"scripts": {}
33+
}

0 commit comments

Comments
 (0)