docs: Update Code of Conduction, Contributing and templates (#145)

* feat: Add Code of Conduct

this Code of Conduct will be Enforced on the TCGdex's Github and on the TCGdex's Discord

* Update Issue templates

Signed-off-by: Avior <github@avior.me>

* Updated Documents

Signed-off-by: Avior <github@avior.me>

.github/ISSUE_TEMPLATE/api-issue.yml

@@ -0,0 +1,36 @@
+name: API Issue Report
+description: Use this when you found an issue involving the TCGdex Server
+title: "issue:"
+labels: [issue, server]
+body:
+
+  - type: markdown
+    attributes:
+      value: |
+        Thanks for taking the time to help advance the project witg your issue report!
+
+  - type: checkboxes
+    id: issue-location
+    validations:
+      required: true
+    attributes:
+      label: Where are you having the issue
+      options:
+        - label: GraphQL
+        - label: JSON API
+
+  - type: checkboxes
+    id: issue-item
+    attributes:
+      label: Is the issue affecting one of the two elements below ?
+      options:
+        - label: Translations
+        - label: Definitions Files (Open API, GraphQL Schema, etc)
+
+  - type: textarea
+    id: description
+    attributes:
+      label: Description
+      description: What is happening
+    validations:
+      required: true

.github/ISSUE_TEMPLATE/config.yml

@@ -0,0 +1,5 @@
+blank_issues_enabled: false
+contact_links:
+  - name: TCGdex Discord
+    url: https://discord.gg/NehYTAhsZE
+    about: You can post user code related issues here.

.github/ISSUE_TEMPLATE/database-issue.yml

@@ -0,0 +1,41 @@
+name: Database Issue Report
+description: Use this when you found an issue involving the TCGdex Datas
+title: "issue:"
+labels: [issue, database]
+body:
+
+  - type: markdown
+    attributes:
+      value: |
+        Thanks for taking the time to help advance the project witg your issue report!
+
+        Note: if the issue is affecting translations or definitions files the correct issue report as the API one
+
+  - type: dropdown
+    id: data-type
+    validations:
+      required: true
+    attributes:
+      label: What seems to be the issue
+      description: Select the types of data that seems to be causing issues
+      options:
+        - label: Card
+        - label: Set
+        - label: Serie
+        - label: Other
+  - type: input
+    id: fields
+    attributes:
+      label: Field(s)
+      description: Tell which field(s) have the issue
+      placeholder: "ex: the Regulation Mark field"
+    validations:
+      required: true
+  - type: textarea
+    id: description
+    attributes:
+      label: Description
+      description: Describe Your problem
+      placeholder: "ex: The cards have an incorrect name"
+    validations:
+      required: true

.github/ISSUE_TEMPLATE/enhancement.yml

@@ -1,7 +1,7 @@
 name: Enhancement
-description: You have an Idea that will enhance the API, Use this issue Template!
+description: Use this template if you have an Idea that will enhance the API/Database
-title: "[Up]: "
+title: "enhancement: "
-labels: [project/database, project/server, project/compiler, type/enhancement]
+labels: [enhancement]
 body:
   - type: markdown
     attributes:
@@ -25,6 +25,6 @@ body:
     attributes:
       label: Please explain in more details what idea you have
       description: If you selected Other or new Data Type please put it as the first line
-      placeholder: "Ex: I would love to see the cards have this new field..."
+      placeholder: "Ex: I would love to see the cards have this new awesome field..."
     validations:
       required: true

.github/ISSUE_TEMPLATE/incorrect-data.yml

@@ -1,26 +0,0 @@
-name: Incorect Data
-description: Use this when you found an incorrect information on a card/set/serie
-title: "[Data]: "
-labels: [project/database, type/incorrect-data]
-body:
-  - type: markdown
-    attributes:
-      value: |
-        Thanks for taking the time to help correct incorrect informations about the database!
-        It should take less than a day to get an answer!
-  - type: textarea
-    id: incorrect
-    attributes:
-      label: Path of the incorrect file(s)
-      description: Fill the different files that have incorrect informations (one per line) (you can use * if it concern a lot of files)
-      placeholder: "ex: data/Sword & Shield/Sword & Shield/1.ts"
-    validations:
-      required: true
-  - type: textarea
-    id: description
-    attributes:
-      label: Incorrect informations
-      description: Describe the incorrect informations
-      placeholder: "ex: The cards have an incorrect name"
-    validations:
-      required: true

.github/ISSUE_TEMPLATE/new-set.yml

@@ -1,7 +1,7 @@
 name: New Set
-description: Use this Issue Template when you found a New set!
+description: Issue Template used when a new set has been announced by TPC
-title: "[Set]: {Set Name}"
+title: "new set: {Set Name}"
-labels: [type/new-set, project/database]
+labels: [database]
 body:
   - type: markdown
     attributes:
@@ -11,7 +11,7 @@ body:
     id: source
     attributes:
       label: Source
-      description: Where did you find out about this new set
+      description: Where did you find out about this new set (domain name MUST be pokemon.com)
       placeholder: "ex: https://www.pokemon.com/us/pokemon-tcg/sword-shield-evolving-skies/explore-and-watch/"
     validations:
       required: true

.github/PULL_REQUEST_TEMPLATE.md

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

.github/dependabot.yml

@@ -5,13 +5,18 @@
 
 version: 2
 updates:
-  - package-ecosystem: "npm" # See documentation for possible values
+
-    directory: "/" # Location of package manifests
+  - package-ecosystem: "npm"
-    schedule:
+    directory: "/"
-      interval: "daily"
+    schedule:
-  - package-ecosystem: "github-actions"
+      interval: "daily"
-    # Workflow files stored in the
+
-    # default location of `.github/workflows`
+  - package-ecosystem: "npm"
+    directory: "/server"
+    schedule:
+      interval: "daily"
+
+  - package-ecosystem: "github-actions"
     directory: "/"
     schedule:
       interval: "daily"

CODE_OF_CONDUCT.md

@@ -0,0 +1,128 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+We as members, contributors, and leaders pledge to make participation in our
+community a harassment-free experience for everyone, regardless of age, body
+size, visible or invisible disability, ethnicity, sex characteristics, gender
+identity and expression, level of experience, education, socio-economic status,
+nationality, personal appearance, race, religion, or sexual identity
+and orientation.
+
+We pledge to act and interact in ways that contribute to an open, welcoming,
+diverse, inclusive, and healthy community.
+
+## Our Standards
+
+Examples of behavior that contributes to a positive environment for our
+community include:
+
+* Demonstrating empathy and kindness toward other people
+* Being respectful of differing opinions, viewpoints, and experiences
+* Giving and gracefully accepting constructive feedback
+* Accepting responsibility and apologizing to those affected by our mistakes,
+  and learning from the experience
+* Focusing on what is best not just for us as individuals, but for the
+  overall community
+
+Examples of unacceptable behavior include:
+
+* The use of sexualized language or imagery, and sexual attention or
+  advances of any kind
+* Trolling, insulting or derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or email
+  address, without their explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Enforcement Responsibilities
+
+Community leaders are responsible for clarifying and enforcing our standards of
+acceptable behavior and will take appropriate and fair corrective action in
+response to any behavior that they deem inappropriate, threatening, offensive,
+or harmful.
+
+Community leaders have the right and responsibility to remove, edit, or reject
+comments, commits, code, wiki edits, issues, and other contributions that are
+not aligned to this Code of Conduct, and will communicate reasons for moderation
+decisions when appropriate.
+
+## Scope
+
+This Code of Conduct applies within all community spaces, and also applies when
+an individual is officially representing the community in public spaces.
+Examples of representing our community include using an official e-mail address,
+posting via an official social media account, or acting as an appointed
+representative at an online or offline event.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported to the community leaders responsible for enforcement at
+the `contact@tcgdex.net` email or on Discord to `Avior#3872`.
+All complaints will be reviewed and investigated promptly and fairly.
+
+All community leaders are obligated to respect the privacy and security of the
+reporter of any incident.
+
+## Enforcement Guidelines
+
+Community leaders will follow these Community Impact Guidelines in determining
+the consequences for any action they deem in violation of this Code of Conduct:
+
+### 1. Correction
+
+**Community Impact**: Use of inappropriate language or other behavior deemed
+unprofessional or unwelcome in the community.
+
+**Consequence**: A private, written warning from community leaders, providing
+clarity around the nature of the violation and an explanation of why the
+behavior was inappropriate. A public apology may be requested.
+
+### 2. Warning
+
+**Community Impact**: A violation through a single incident or series
+of actions.
+
+**Consequence**: A warning with consequences for continued behavior. No
+interaction with the people involved, including unsolicited interaction with
+those enforcing the Code of Conduct, for a specified period of time. This
+includes avoiding interactions in community spaces as well as external channels
+like social media. Violating these terms may lead to a temporary or
+permanent ban.
+
+### 3. Temporary Ban
+
+**Community Impact**: A serious violation of community standards, including
+sustained inappropriate behavior.
+
+**Consequence**: A temporary ban from any sort of interaction or public
+communication with the community for a specified period of time. No public or
+private interaction with the people involved, including unsolicited interaction
+with those enforcing the Code of Conduct, is allowed during this period.
+Violating these terms may lead to a permanent ban.
+
+### 4. Permanent Ban
+
+**Community Impact**: Demonstrating a pattern of violation of community
+standards, including sustained inappropriate behavior,  harassment of an
+individual, or aggression toward or disparagement of classes of individuals.
+
+**Consequence**: A permanent ban from any sort of public interaction within
+the community.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage],
+version 2.0, available at
+https://www.contributor-covenant.org/version/2/0/code_of_conduct.html.
+
+Community Impact Guidelines were inspired by [Mozilla's code of conduct
+enforcement ladder](https://github.com/mozilla/diversity).
+
+[homepage]: https://www.contributor-covenant.org
+
+For answers to common questions about this code of conduct, see the FAQ at
+https://www.contributor-covenant.org/faq. Translations are available at
+https://www.contributor-covenant.org/translations.

CONTRIBUTING.md

@@ -1,33 +1,200 @@
-# How to contribute
+<!-- omit in toc -->
 
-If you are here, I like you already !
+# Contributing to TCGdex
 
-## TL::DR
+First off, thanks for taking the time to contribute! ❤️
 
-A card is missing or has incorrect informations?
+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. 🎉
 
-feel free to contribute to the database by adding [an Issue](https://github.com/tcgdex/cards-database/issues/new), [a Discussion](https://github.com/tcgdex/cards-database/discussions/new) or [a Pull Request](https://github.com/tcgdex/cards-database/pulls/compare)
+> 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:
+> 
+> - Star the project
+> - Tweet about it
+> - Refer this project in your project's readme
+> - Mention the project at local meetups and tell your friends/colleagues
 
-## Database Issue or recomendation
+<!-- omit in toc -->
 
-We would love you to see what you can propose to make the Database/API better !
+## Table of Contents
 
-to do this you can check if there is not already an issue/discussion about it, and if there is nothing, add a new [Issues](https://github.com/tcgdex/cards-database/issues/new) if it's already well though, or [create a new discussion](https://github.com/tcgdex/cards-database/discussions/new) to speak about it
+- [Code of Conduct](#code-of-conduct)
+- [I Have a Question](#i-have-a-question)
+- [I Want To Contribute](#i-want-to-contribute)
+  - [Reporting Issues](#reporting-issues)
+  - [Suggesting Enhancements](#suggesting-enhancements)
+  - [Your First Code Contribution](#your-first-code-contribution)
+  - [Improving The Documentation](#improving-the-documentation)
+- [Styleguides](#styleguides)
+  - [Coding Guidlines](#coding-guidelines)
+  - [Commit Messages](#commit-messages)
+- [Join The Project Team](#join-the-project-team)
 
-## Pushing changes
+## Code of Conduct
 
-To send changes to our repository, you will have to follow the next steps:
+This project and everyone participating in it is governed by the
+[TCGdex Code of Conduct](https://github.com/tcgdex/cards-database/blob/master/CODE_OF_CONDUCT.md).
+By participating, you are expected to uphold this code. Please report unacceptable behavior to <contact@tcgdex.net>.
+
+## I Have a Question
+
+> If you want to ask a question, we assume that you have read the available Documentation at <https://www.tcgdex.dev>.
+
+The best way to ask questions is to join our Discord server at <https://discord.gg/NehYTAhsZE>.
+
+You can also ask them on the Github Repository, it is best to search for existing [Issues](https://github.com/tcgdex/cards-database/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.
+
+If you then still feel the need to ask a question and need clarification, we recommend the following:
+
+- Open an [Issue](https://github.com/tcgdex/cards-database/issues/new/choose).
+- Provide as much context as you can about what you're running into.
+- Provide project and platform versions (nodejs, npm, etc), depending on what seems relevant.
+
+We will then take care of the issue as soon as possible.
+
+<!--
+You might want to create a separate issue tag for questions and include it in this description. People should then tag their issues accordingly.
+
+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:
+- IRC
+- Slack
+- Gitter
+- Stack Overflow tag
+- Blog
+- FAQ
+- Roadmap
+- E-Mail List
+- Forum
+-->
+
+## I Want To Contribute
+
+> ### Legal Notice <!-- omit in toc -->
+> 
+> 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.
+
+### Reporting Issues
+
+<!-- omit in toc -->
+
+#### Before Submitting an Issue Report
+
+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.
+
+- 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)).
+- 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/cards-database/issues).
+- Also make sure to search the internet (including Stack Overflow) to see if users outside of the GitHub community have discussed the issue.
+- Collect information about the bug:
+  - Stack trace (Traceback)
+  - OS, Platform and Version (Windows, Linux, macOS, x86, ARM)
+  - Version of the interpreter, compiler, SDK, runtime environment, package manager, depending on what seems relevant.
+  - Possibly your input and the output
+  - Can you reliably reproduce the issue? And can you also reproduce it with older versions?
+
+<!-- omit in toc -->
+
+#### How Do I Submit a Good Bug Report?
+
+> 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>.
+
+<!-- You may add a PGP key to allow the messages to be sent encrypted as well. -->
+
+We use GitHub issues to track bugs and errors. If you run into an issue with the project:
+
+- Open an [Issue](https://github.com/tcgdex/cards-databaseissues/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.)
+- Explain the behavior you would expect and the actual behavior.
+- 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.
+- Provide the information you collected in the previous section.
+
+Once it's filed:
+
+- The project team will label the issue accordingly.
+- 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.
+- 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).
+
+<!-- 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. -->
+
+### Suggesting Enhancements
+
+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.
+
+<!-- omit in toc -->
+
+#### Before Submitting an Enhancement
+
+- Make sure that you are using the latest version.
+- Read the [documentation](https://www.tcgdex.dev) carefully and find out if the functionality is already covered, maybe by an individual configuration.
+- Perform a [search](https://github.com/tcgdex/cards-databaseissues) 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.
+- 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.
+
+<!-- omit in toc -->
+
+#### How Do I Submit a Good Enhancement Suggestion?
+
+Enhancement suggestions are tracked as [GitHub issues](https://github.com/tcgdex/cards-databaseissues).
+
+- Use a **clear and descriptive title** for the issue to identify the suggestion.
+- Provide a **step-by-step description of the suggested enhancement** in as many details as possible.
+- **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.
+- 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 -->
+- **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.
+
+<!-- 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. -->
+
+### Your First Code Contribution
+
+_note: Follow the different styleguides listed below when contributing_
 
 - Fork 🍴 the project. _see the `fork` button at the top right of the screen_
 - make the changes you want in your repository.
-- Create a Pull request here https://github.com/tcgdex/cards-database/compare by selecting your repository patch with our `master` branch
+- Create a Pull request here https://github.com/tcgdex/cards-database/compare by selecting your repository patch with our `master` branch _If it's not finished put WIP: before_
 - 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 !
-- If you pull request is ready for review you can go to the 🏖️ and we will handle the rest !
+- If your pull request is ready for review remove WIP: put it s ready for review and we will handle the rest !
 
-## coding Convention
+### Improving The Documentation
+
+The documentation is updated in the Documentation repository at <https://github.com/tcgdex/documentation>
+
+## Styleguides
+
+### Coding Guidelines
 
 Install the plugin `.editorconfig` in your dev environment if it's not already done and thats it !
 
 for those who don't want to install it the basic are these:
-- Indent using `tab`
+- Indent using the `tab` or `\t` character
+- the line feed character is `\n`
+- only use `;` when necessary and at the start of the line
+- use double quotes `"` when editing files in the `data/` folder and single quote `'` in other files
 - don't uglify your code (_why would you even do it_)
+
+### Commit Messages
+
+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.
+
+In short, please name your Pull Requests/Commits following this format
+```
+<type>(<scope>): <short summary>
+<BLANK LINE>
+<body>
+<BLANK LINE>
+<footer>
+```
+
+- `type` MUST be one of
+  - build: Changes affecting the files at `server/compiler`
+  - ci: Changes affecting the CI at `.github/workflows` or `Dockerfile`
+  - docs: Changes affecting the differents `.md` files
+  - feat: a new field/feature being added
+  - fix: data fixes/server fixes
+  - pref: Performance related fixes
+  - refactor: Misc code changes
+  - test: same as `ci`
+- the field `(<scope>)` is optional
+- `short summary` MUST follow thoses rules
+  -  Capitalize the first letter
+  -  use the imperative, present tense: "Change" not "Changed" nor "Changes"
+- `<footer>` and `<body>` are both optional
+
+## Attribution
+
+This guide is based on [Contribution Gen]((https://github.com/bttger/contributing-gen)) and was adapted by the TCGdex community !

README.md

@@ -1,6 +1,6 @@
 <p align="center">
 	<a href="https://www.tcgdex.net">
-		<img src="https://repository-images.githubusercontent.com/241652591/01dd7200-ca01-11eb-98e0-d8f04e7dfe42" width="50%" alt="Discord Link">
+		<img src="https://www.tcgdex.net/assets/og.png" width="90%" alt="TCGdex Main Image">
 	</a>
 </p>
 <p align="center">
@@ -21,50 +21,52 @@
 <!-- ALL-CONTRIBUTORS-BADGE:END -->
 </p>
 
-# Pokemon TCGdex Cards Database
+# TCGdex - Pokémon TCG Cards Database
 
 A Multilanguage Pokémon TCG Database with Cards Pictures and most of the informations contained on the cards.
 
-## Translations
+## Getting Started
 
-|             | English | French | German | Italian | Portuguese | Spanish |
+_If you need help for using/editing the database, [join our Discord server](https://discord.gg/NehYTAhsZE)!_
-|-------------|---------|--------|--------|---------|------------|---------|
-| Cards       | 13869   | 9464   | 6133   | 6133    | 6133       | 6133    |
-| Translated  | 100%    | 68%    | 44%    | 44%     | 44%        | 44%     |
 
-_want to help translating? each object fields on cards that have at least en,fr,es,de,it,pt can have the others!,_
+### Using the Database
-_Also we have another translation files located at `meta/translations`_
 
-## Interact with the Database
+_The full documentation is available at <https://www.tcgdex.dev>_
 
-_documentation available at https://www.tcgdex.net/docs_
+- The easiest way to interact with the database is by using one of our SDKs listed below.
+- You can also direcly use the endpoints at `api.tcgdex.net` (see the documentation).
+- You can build the API yourself by using our `Dockerfile` and using it on the port 3000
 
-- The easiest way to interact with the database is by using one of our SDKs _list below_.
+#### SDKs / API Wrappers
-- You can also direcly use the endpoints at `api.tcgdex.net`.
-- You can build the API yourself by using our [compiler](https://github.com/tcgdex/compiler) or download the already [compiled database](https://github.com/tcgdex/distribution).
-
-## SDKs / API Wrappers
 
 We currently officially support theses SDKs
 
 - [Javascript/Typescript SDK](https://github.com/tcgdex/javascript-sdk)
 - [PHP SDK](https://github.com/tcgdex/php-sdk)
+- [Java SDK](https://github.com/tcgdex/java-sdk)
 
-_If you have a SDK, start a [discussion](https://github.com/tcgdex/cards-database/discussions/new) to be added here_
+### Editing the Database
 
+There is three sub folders that will allow you to edit some faces of the database
 
-## Join Us on Discord
+- `/data`: Contains Cards Data architectured around `SerieName/SetName/CardLocalId` folders
-
+- `/meta`: Contains informations for the project (definitions files, Translations for some fields)
-You want to ask something or you just want to discuss anything from an idea/improvement about the API to why Furret should be in the next Pokken Tournament game...
-
-Well you can join us on [Discord](https://discord.gg/NehYTAhsZE) !
-
-## Project Architecture
-
-- `/data`: Contains Cards Data architectured around `Series/Set/localId` folders
-- `/meta`: Contains misc informations for the project (more details in the README.md in `/meta`)
 - `/server`: The server that allow to communicate with the database
 
+## Translations
+
+We have a big effort on translating datas for older sets
+
+_note: numbers updated manually_
+
+|             | English | French | German | Italian | Portuguese | Spanish |
+|-------------|---------|--------|--------|---------|------------|---------|
+| Cards       | 14419   | 9846   | 6590   | 6576    | 6593       | 6590    |
+| Translated  | 100%    | 68.2%  | 45.7%  | 45.6%   | 45.7%      | 45.7%   |
+
+_want to help translating? each object fields on cards that have at least en,fr,es,de,it or pt can have the others!,_
+_Also we have another translation files located at `meta/translations`_
+
 ## Contributing
 
 See [CONTRIBUTING.md](./CONTRIBUTING.md)
@@ -78,12 +80,6 @@ TL::DR
 
 As of February 2021, the v1 API is no longer supported.
 
-## License
-
-This database is not produced, endorsed, supported or affiliated with Nintendo or The Pokémon Company
-
-The Database is licensed under the MIT License. A copy of the license is available in [LICENSE](./LICENSE)
-
 ## Contributors ✨
 
 Thanks goes to these wonderful people ([emoji key](https://allcontributors.org/docs/en/emoji-key)):
@@ -106,3 +102,9 @@ Thanks goes to these wonderful people ([emoji key](https://allcontributors.org/d
 <!-- ALL-CONTRIBUTORS-LIST:END -->
 
 This project follows the [all-contributors](https://github.com/all-contributors/all-contributors) specification. Contributions of any kind welcome!
+
+## Licenses
+
+This database is not produced, endorsed, supported or affiliated with Nintendo or The Pokémon Company
+
+The Database is licensed under the MIT License. A copy of the license is available in [LICENSE](./LICENSE)

meta/README.md

@@ -6,7 +6,7 @@ this folder contains data that allow to build and quickly edit the database
 
 simple file that contains an easy way to edit multiple entries of the database
 
-run it from the root folder of the project
+run it from the root folder of the project with jscodeshift added using `npm i jscodeshift`
 
 ```bash
 npx jscodeshift -t ./meta/codeshift.ts --extensions=ts --parser=ts ./data/Serie/Set --print --dry
@@ -16,6 +16,10 @@ npx jscodeshift -t ./meta/codeshift.ts --extensions=ts --parser=ts ./data/Serie/
 
 Contains the differents standards of API/Data definition for the built database
 
+- `openapi.yaml`: Open API definition
+- `graphql.gql`: GraphQL definitions
+- `api.d.ts`: API definition for the SDKs
+
 ## Translations
 
 Contains the different translations used by the Compiler that allow to build it in multiple languages