Skip to content

Commit a22196c

Browse files
AviorthekingAviortheking
authored
refactor: Documents changes (#6)
1 parent 79358d8 commit a22196c

File tree

7 files changed

+402
-1
lines changed

7 files changed

+402
-1
lines changed

‎.github/ISSUE_TEMPLATE/bug.yml

+32
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,32 @@
1+
name: Bug
2+
description: Use this template if you have found a bug in the SDK
3+
title: "bug: "
4+
labels: [bug]
5+
body:
6+
- type: markdown
7+
attributes:
8+
value: |
9+
Thanks for taking the time to fill out this Form!
10+
- type: textarea
11+
id: happening
12+
attributes:
13+
label: What is Hapening
14+
placeholder: "Ex: When using this function the SDK crash..."
15+
validations:
16+
required: true
17+
- type: textarea
18+
id: happen
19+
attributes:
20+
label: Please explain what should happen
21+
description: If you selected Other or new Data Type please put it as the first line
22+
placeholder: "Ex: The SDK should not crash"
23+
validations:
24+
required: true
25+
- type: textarea
26+
id: reproducre
27+
attributes:
28+
label: Please give us a way to reproduce
29+
description: You can list a way or give us access to a minimal Github repo to reproduce it
30+
placeholder: "Ex: https://github.com/tcgdex/php-sdk-error-idk"
31+
validations:
32+
required: true

‎.github/ISSUE_TEMPLATE/enhancement.yml

+16
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
name: Enhancement
2+
description: Use this template if you have an Idea that will enhance the SDK
3+
title: "enhancement: "
4+
labels: [enhancement]
5+
body:
6+
- type: markdown
7+
attributes:
8+
value: |
9+
Thanks for taking the time to fill out this Form!
10+
- type: textarea
11+
id: explain
12+
attributes:
13+
label: Please explain in more details what idea you have
14+
placeholder: "Ex: I would love to see this or this..."
15+
validations:
16+
required: true

‎.github/PULL_REQUEST_TEMPLATE.md

+5
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
<!--
2+
Thanks for your Pull Request, Please provide the related Issue using "Fix #0" or describe the change(s) you made.
3+
The issue title must follow Conventional Commit (verified by Github Actions) conventionalcommits.org.
4+
More informations at https://github.com/tcgdex/cards-database/blob/master/CONTRIBUTING.md
5+
-->

‎.github/dependabot.yml

+22
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
1+
# To get started with Dependabot version updates, you'll need to specify which
2+
# package ecosystems to update and where the package manifests are located.
3+
# Please see the documentation for all configuration options:
4+
# https://help.github.com/github/administering-a-repository/configuration-options-for-dependency-updates
5+
6+
version: 2
7+
updates:
8+
9+
- package-ecosystem: "composer"
10+
directory: "/"
11+
schedule:
12+
interval: "daily"
13+
versioning-strategy: lockfile-only
14+
commit-message:
15+
prefix: build
16+
17+
- package-ecosystem: "github-actions"
18+
directory: "/"
19+
schedule:
20+
interval: "daily"
21+
commit-message:
22+
prefix: build

‎CODE_OF_CONDUCT.md

+128
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,128 @@
1+
# Contributor Covenant Code of Conduct
2+
3+
## Our Pledge
4+
5+
We as members, contributors, and leaders pledge to make participation in our
6+
community a harassment-free experience for everyone, regardless of age, body
7+
size, visible or invisible disability, ethnicity, sex characteristics, gender
8+
identity and expression, level of experience, education, socio-economic status,
9+
nationality, personal appearance, race, religion, or sexual identity
10+
and orientation.
11+
12+
We pledge to act and interact in ways that contribute to an open, welcoming,
13+
diverse, inclusive, and healthy community.
14+
15+
## Our Standards
16+
17+
Examples of behavior that contributes to a positive environment for our
18+
community include:
19+
20+
* Demonstrating empathy and kindness toward other people
21+
* Being respectful of differing opinions, viewpoints, and experiences
22+
* Giving and gracefully accepting constructive feedback
23+
* Accepting responsibility and apologizing to those affected by our mistakes,
24+
and learning from the experience
25+
* Focusing on what is best not just for us as individuals, but for the
26+
overall community
27+
28+
Examples of unacceptable behavior include:
29+
30+
* The use of sexualized language or imagery, and sexual attention or
31+
advances of any kind
32+
* Trolling, insulting or derogatory comments, and personal or political attacks
33+
* Public or private harassment
34+
* Publishing others' private information, such as a physical or email
35+
address, without their explicit permission
36+
* Other conduct which could reasonably be considered inappropriate in a
37+
professional setting
38+
39+
## Enforcement Responsibilities
40+
41+
Community leaders are responsible for clarifying and enforcing our standards of
42+
acceptable behavior and will take appropriate and fair corrective action in
43+
response to any behavior that they deem inappropriate, threatening, offensive,
44+
or harmful.
45+
46+
Community leaders have the right and responsibility to remove, edit, or reject
47+
comments, commits, code, wiki edits, issues, and other contributions that are
48+
not aligned to this Code of Conduct, and will communicate reasons for moderation
49+
decisions when appropriate.
50+
51+
## Scope
52+
53+
This Code of Conduct applies within all community spaces, and also applies when
54+
an individual is officially representing the community in public spaces.
55+
Examples of representing our community include using an official e-mail address,
56+
posting via an official social media account, or acting as an appointed
57+
representative at an online or offline event.
58+
59+
## Enforcement
60+
61+
Instances of abusive, harassing, or otherwise unacceptable behavior may be
62+
reported to the community leaders responsible for enforcement at
63+
the `contact@tcgdex.net` email or on Discord to `Avior#3872`.
64+
All complaints will be reviewed and investigated promptly and fairly.
65+
66+
All community leaders are obligated to respect the privacy and security of the
67+
reporter of any incident.
68+
69+
## Enforcement Guidelines
70+
71+
Community leaders will follow these Community Impact Guidelines in determining
72+
the consequences for any action they deem in violation of this Code of Conduct:
73+
74+
### 1. Correction
75+
76+
**Community Impact**: Use of inappropriate language or other behavior deemed
77+
unprofessional or unwelcome in the community.
78+
79+
**Consequence**: A private, written warning from community leaders, providing
80+
clarity around the nature of the violation and an explanation of why the
81+
behavior was inappropriate. A public apology may be requested.
82+
83+
### 2. Warning
84+
85+
**Community Impact**: A violation through a single incident or series
86+
of actions.
87+
88+
**Consequence**: A warning with consequences for continued behavior. No
89+
interaction with the people involved, including unsolicited interaction with
90+
those enforcing the Code of Conduct, for a specified period of time. This
91+
includes avoiding interactions in community spaces as well as external channels
92+
like social media. Violating these terms may lead to a temporary or
93+
permanent ban.
94+
95+
### 3. Temporary Ban
96+
97+
**Community Impact**: A serious violation of community standards, including
98+
sustained inappropriate behavior.
99+
100+
**Consequence**: A temporary ban from any sort of interaction or public
101+
communication with the community for a specified period of time. No public or
102+
private interaction with the people involved, including unsolicited interaction
103+
with those enforcing the Code of Conduct, is allowed during this period.
104+
Violating these terms may lead to a permanent ban.
105+
106+
### 4. Permanent Ban
107+
108+
**Community Impact**: Demonstrating a pattern of violation of community
109+
standards, including sustained inappropriate behavior, harassment of an
110+
individual, or aggression toward or disparagement of classes of individuals.
111+
112+
**Consequence**: A permanent ban from any sort of public interaction within
113+
the community.
114+
115+
## Attribution
116+
117+
This Code of Conduct is adapted from the [Contributor Covenant][homepage],
118+
version 2.0, available at
119+
https://www.contributor-covenant.org/version/2/0/code_of_conduct.html.
120+
121+
Community Impact Guidelines were inspired by [Mozilla's code of conduct
122+
enforcement ladder](https://github.com/mozilla/diversity).
123+
124+
[homepage]: https://www.contributor-covenant.org
125+
126+
For answers to common questions about this code of conduct, see the FAQ at
127+
https://www.contributor-covenant.org/faq. Translations are available at
128+
https://www.contributor-covenant.org/translations.

‎CONTRIBUTING.md

+191
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,191 @@
1+
<!-- omit in toc -->
2+
3+
# Contributing to TCGdex
4+
5+
First off, thanks for taking the time to contribute! ❤️
6+
7+
All types of contributions are encouraged and valued. See the [Table of Contents](#table-of-contents) for different ways to help and details about how this project handles them. Please make sure to read the relevant section before making your contribution. It will make it a lot easier for us maintainers and smooth out the experience for all involved. The community looks forward to your contributions. 🎉
8+
9+
> And if you like the project, but just don't have time to contribute, that's fine. There are other easy ways to support the project and show your appreciation, which we would also be very happy about:
10+
>
11+
> - Star the project
12+
> - Tweet about it
13+
> - Refer this project in your project's readme
14+
> - Mention the project at local meetups and tell your friends/colleagues
15+
<!-- omit in toc -->
16+
17+
## Table of Contents
18+
19+
- [Code of Conduct](#code-of-conduct)
20+
- [I Have a Question](#i-have-a-question)
21+
- [I Want To Contribute](#i-want-to-contribute)
22+
- [Reporting Issues](#reporting-issues)
23+
- [Suggesting Enhancements](#suggesting-enhancements)
24+
- [Your First Code Contribution](#your-first-code-contribution)
25+
- [Improving The Documentation](#improving-the-documentation)
26+
- [Styleguides](#styleguides)
27+
- [Coding Guidlines](#coding-guidelines)
28+
- [Commit Messages](#commit-messages)
29+
- [Join The Project Team](#join-the-project-team)
30+
31+
## Code of Conduct
32+
33+
This project and everyone participating in it is governed by the
34+
[TCGdex Code of Conduct](https://github.com/tcgdex/php-sdk/blob/master/CODE_OF_CONDUCT.md).
35+
By participating, you are expected to uphold this code. Please report unacceptable behavior to <contact@tcgdex.net>.
36+
37+
## I Have a Question
38+
39+
> If you want to ask a question, we assume that you have read the available Documentation at <https://www.tcgdex.dev>.
40+
The best way to ask questions is to join our Discord server at <https://discord.gg/NehYTAhsZE>.
41+
42+
You can also ask them on the Github Repository, it is best to search for existing [Issues](https://github.com/tcgdex/php-sdk/issues) that might help you. In case you have found a suitable issue and still need clarification, you can write your question in a new issue. It is also advisable to search the internet for answers first.
43+
44+
If you then still feel the need to ask a question and need clarification, we recommend the following:
45+
46+
- Open an [Issue](https://github.com/tcgdex/php-sdk/issues/new).
47+
- Provide as much context as you can about what you're running into.
48+
- Provide project and platform versions (nodejs, npm, etc), depending on what seems relevant.
49+
50+
We will then take care of the issue as soon as possible.
51+
52+
<!--
53+
You might want to create a separate issue tag for questions and include it in this description. People should then tag their issues accordingly.
54+
Depending on how large the project is, you may want to outsource the questioning, e.g. to Stack Overflow or Gitter. You may add additional contact and information possibilities:
55+
- IRC
56+
- Slack
57+
- Gitter
58+
- Stack Overflow tag
59+
- Blog
60+
- FAQ
61+
- Roadmap
62+
- E-Mail List
63+
- Forum
64+
-->
65+
66+
## I Want To Contribute
67+
68+
> ### Legal Notice <!-- omit in toc -->
69+
>
70+
> When contributing to this project, you must agree that you have authored 100% of the content, that you have the necessary rights to the content and that the content you contribute may be provided under the project license.
71+
### Reporting Issues
72+
73+
<!-- omit in toc -->
74+
75+
#### Before Submitting an Issue Report
76+
77+
A good issue report shouldn't leave others needing to chase you up for more information. Therefore, we ask you to investigate carefully, collect information and describe the issue in detail in your report. Please complete the following steps in advance to help us fix any potential bug as fast as possible.
78+
79+
- Determine if your issue is not an error on your side e.g. using incompatible environment components/versions (Make sure that you have read the [documentation](https://www.tcgdex.dev). If you are looking for support, you might want to check [this section](#i-have-a-question)).
80+
- To see if other users have experienced (and potentially already solved) the same issue you are having, check if there is not already an issue report existing for your bug or error in the [bug tracker](https://github.com/tcgdex/php-sdk/issues).
81+
- Also make sure to search the internet (including Stack Overflow) to see if users outside of the GitHub community have discussed the issue.
82+
- Collect information about the bug:
83+
- Stack trace (Traceback)
84+
- OS, Platform and Version (Windows, Linux, macOS, x86, ARM)
85+
- Version of the interpreter, compiler, SDK, runtime environment, package manager, depending on what seems relevant.
86+
- Possibly your input and the output
87+
- Can you reliably reproduce the issue? And can you also reproduce it with older versions?
88+
89+
<!-- omit in toc -->
90+
91+
#### How Do I Submit a Good Bug Report?
92+
93+
> You must never report security related issues, vulnerabilities or bugs to the issue tracker, or elsewhere in public. Instead sensitive bugs must be sent by email to <security@tcgdex.net>.
94+
<!-- You may add a PGP key to allow the messages to be sent encrypted as well. -->
95+
96+
We use GitHub issues to track bugs and errors. If you run into an issue with the project:
97+
98+
- Open an [Issue](https://github.com/tcgdex/php-sdk/issues/new). (Since we can't be sure at this point whether it is a bug or not, we ask you not to talk about a bug yet and not to label the issue.)
99+
- Explain the behavior you would expect and the actual behavior.
100+
- Please provide as much context as possible and describe the *reproduction steps* that someone else can follow to recreate the issue on their own. This usually includes your code. For good bug reports you should isolate the problem and create a reduced test case.
101+
- Provide the information you collected in the previous section.
102+
103+
Once it's filed:
104+
105+
- The project team will label the issue accordingly.
106+
- A team member will try to reproduce the issue with your provided steps. If there are no reproduction steps or no obvious way to reproduce the issue, the team will ask you for those steps and mark the issue as `needs-repro`. Bugs with the `needs-repro` tag will not be addressed until they are reproduced.
107+
- If the team is able to reproduce the issue, it will be marked `needs-fix`, as well as possibly other tags (such as `critical`), and the issue will be left to be [implemented by someone](#your-first-code-contribution).
108+
109+
<!-- You might want to create an issue template for bugs and errors that can be used as a guide and that defines the structure of the information to be included. If you do so, reference it here in the description. -->
110+
111+
### Suggesting Enhancements
112+
113+
This section guides you through submitting an enhancement suggestion for TCGdex, **including completely new features and minor improvements to existing functionality**. Following these guidelines will help maintainers and the community to understand your suggestion and find related suggestions.
114+
115+
<!-- omit in toc -->
116+
117+
#### Before Submitting an Enhancement
118+
119+
- Make sure that you are using the latest version.
120+
- Read the [documentation](https://www.tcgdex.dev) carefully and find out if the functionality is already covered, maybe by an individual configuration.
121+
- Perform a [search](https://github.com/tcgdex/php-sdk/issues) to see if the enhancement has already been suggested. If it has, add a comment to the existing issue instead of opening a new one.
122+
- Find out whether your idea fits with the scope and aims of the project. It's up to you to make a strong case to convince the project's developers of the merits of this feature. Keep in mind that we want features that will be useful to the majority of our users and not just a small subset. If you're just targeting a minority of users, consider writing an add-on/plugin library.
123+
124+
<!-- omit in toc -->
125+
126+
#### How Do I Submit a Good Enhancement Suggestion?
127+
128+
Enhancement suggestions are tracked as [GitHub issues](https://github.com/tcgdex/php-sdk/issues).
129+
130+
- Use a **clear and descriptive title** for the issue to identify the suggestion.
131+
- Provide a **step-by-step description of the suggested enhancement** in as many details as possible.
132+
- **Describe the current behavior** and **explain which behavior you expected to see instead** and why. At this point you can also tell which alternatives do not work for you.
133+
- You may want to **include screenshots and animated GIFs** which help you demonstrate the steps or point out the part which the suggestion is related to. You can use [this tool](https://www.cockos.com/licecap/) to record GIFs on macOS and Windows, and [this tool](https://github.com/colinkeenan/silentcast) or [this tool](https://github.com/GNOME/byzanz) on Linux. <!-- this should only be included if the project has a GUI -->
134+
- **Explain why this enhancement would be useful** to most TCGdex users. You may also want to point out the other projects that solved it better and which could serve as inspiration.
135+
136+
<!-- You might want to create an issue template for enhancement suggestions that can be used as a guide and that defines the structure of the information to be included. If you do so, reference it here in the description. -->
137+
138+
### Your First Code Contribution
139+
140+
_note: Follow the different styleguides listed below when contributing_
141+
142+
- Fork 🍴 the project. _see the `fork` button at the top right of the screen_
143+
- make the changes you want in your repository.
144+
- Create a Pull request here https://github.com/tcgdex/php-sdk/compare by selecting your repository patch with our `master` branch _If it's not finished put WIP: before_
145+
- we don't like ❌, so if your pull request has its automated checks ending with the red cross, please double check your changes until it show the awesome 🟢, or ask for help !
146+
- If your pull request is ready for review remove WIP: put it s ready for review and we will handle the rest !
147+
148+
### Improving The Documentation
149+
150+
The documentation is updated in the Documentation repository at <https://github.com/tcgdex/documentation>
151+
152+
## Styleguides
153+
154+
### Coding Guidelines
155+
156+
Install the plugin `.editorconfig` in your dev environment if it's not already done and thats it !
157+
158+
for those who don't want to install it the basic are these:
159+
- Respect PSR12
160+
161+
### Commit Messages
162+
163+
We follow the [Conventional Commit specification](conventionalcommits.org) and are using the [Angular format](https://github.com/angular/angular/blob/master/CONTRIBUTING.md#commit) with some changes.
164+
165+
In short, please name your Pull Requests/Commits following this format
166+
```
167+
<type>(<scope>): <short summary>
168+
<BLANK LINE>
169+
<body>
170+
<BLANK LINE>
171+
<footer>
172+
```
173+
174+
- `type` MUST be one of
175+
- build: Changes affecting the files at `server/compiler`
176+
- ci: Changes affecting the CI at `.github/workflows` or `Dockerfile`
177+
- docs: Changes affecting the differents `.md` files
178+
- feat: a new field/feature being added
179+
- fix: data fixes/server fixes
180+
- pref: Performance related fixes
181+
- refactor: Misc code changes
182+
- test: same as `ci`
183+
- the field `(<scope>)` is optional
184+
- `short summary` MUST follow thoses rules
185+
- Capitalize the first letter
186+
- use the imperative, present tense: "Change" not "Changed" nor "Changes"
187+
- `<footer>` and `<body>` are both optional
188+
189+
## Attribution
190+
191+
This guide is based on [Contribution Gen]((https://github.com/bttger/contributing-gen)) and was adapted by the TCGdex community !

0 commit comments

Comments
 (0)