From 4f2f3aea68a3d23c5d0fd6dfbb03d9404bab87ed Mon Sep 17 00:00:00 2001 From: luchaos Date: Sun, 25 Feb 2024 17:26:21 +0100 Subject: [PATCH] Initial commit --- .editorconfig | 15 +++++++++++++++ .github/ISSUE_TEMPLATE/config.yml | 11 +++++++++++ CODE_OF_CONDUCT.md | 3 +++ CONTRIBUTING.md | 1 + LICENSE.md | 21 +++++++++++++++++++++ README.md | 30 ++++++++++++++++++++++++++++++ SECURITY.md | 18 ++++++++++++++++++ 7 files changed, 99 insertions(+) create mode 100644 .editorconfig create mode 100644 .github/ISSUE_TEMPLATE/config.yml create mode 100644 CODE_OF_CONDUCT.md create mode 100644 CONTRIBUTING.md create mode 100644 LICENSE.md create mode 100644 README.md create mode 100644 SECURITY.md diff --git a/.editorconfig b/.editorconfig new file mode 100644 index 0000000..59f363f --- /dev/null +++ b/.editorconfig @@ -0,0 +1,15 @@ +root = true + +[*] +charset = utf-8 +end_of_line = lf +insert_final_newline = true +indent_style = space +indent_size = 4 +trim_trailing_whitespace = true + +[*.md] +trim_trailing_whitespace = false + +[*.{yml,yaml,neon,rc}] +indent_size = 2 diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml new file mode 100644 index 0000000..f11894a --- /dev/null +++ b/.github/ISSUE_TEMPLATE/config.yml @@ -0,0 +1,11 @@ +blank_issues_enabled: false +contact_links: + - name: Ask a question + url: https://github.com/RetroAchievements/api-python/discussions/new?category=q-a + about: Ask the community for help + - name: Request a feature + url: https://github.com/RetroAchievements/api-python/discussions/new?category=ideas + about: Share ideas for new features + - name: Report a bug + url: https://github.com/RetroAchievements/api-python/issues/new + about: Report a reproducable bug diff --git a/CODE_OF_CONDUCT.md b/CODE_OF_CONDUCT.md new file mode 100644 index 0000000..78c59af --- /dev/null +++ b/CODE_OF_CONDUCT.md @@ -0,0 +1,3 @@ +## Code of Conduct + +Please review and abide by the [Code of Conduct](https://docs.retroachievements.org/Users-Code-of-Conduct/). diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..854139a --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1 @@ +# Contributing diff --git a/LICENSE.md b/LICENSE.md new file mode 100644 index 0000000..2df5cbd --- /dev/null +++ b/LICENSE.md @@ -0,0 +1,21 @@ +MIT License + +Copyright (c) 2024 RetroAchievements.org + +Permission is hereby granted, free of charge, to any person obtaining a copy +of this software and associated documentation files (the "Software"), to deal +in the Software without restriction, including without limitation the rights +to use, copy, modify, merge, publish, distribute, sublicense, and/or sell +copies of the Software, and to permit persons to whom the Software is +furnished to do so, subject to the following conditions: + +The above copyright notice and this permission notice shall be included in all +copies or substantial portions of the Software. + +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR +IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, +FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE +AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER +LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, +OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE +SOFTWARE. diff --git a/README.md b/README.md new file mode 100644 index 0000000..f84aa1c --- /dev/null +++ b/README.md @@ -0,0 +1,30 @@ +

RetroAchievements Logo

+

RetroAchievements Web API Client

+ +## Installation + +WIP + +## Usage + +WIP + +## Testing + +WIP + +## Contributing + +See [Contribution Guidelines](CONTRIBUTING.md) and [Code of Conduct](CODE_OF_CONDUCT.md). + +## Security Vulnerabilities + +Please review [our security policy](../../security/policy). + +## Credits + +- [All Contributors](../../contributors) + +## License + +MIT License (MIT). See [License File](LICENSE.md). diff --git a/SECURITY.md b/SECURITY.md new file mode 100644 index 0000000..38481f0 --- /dev/null +++ b/SECURITY.md @@ -0,0 +1,18 @@ +# Security Policy + +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. + +## Reporting a Vulnerability + +Here's how you can report a security issue: + +1. **Do not report security issues in GitHub issues, discussions, or on Discord.** +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). + +In your report, please include: + +- A brief description of the issue. +- Steps to reproduce the issue, if possible. +- Potential impact of the issue. + +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.