From a7bb5d6452349fbafd323531cd7cb2b03a0e05ec Mon Sep 17 00:00:00 2001 From: Simon <46846093+6im0n@users.noreply.github.com> Date: Tue, 12 Mar 2024 00:45:47 +0100 Subject: [PATCH 1/3] :memo: Add an issue template --- .github/ISSUE_TEMPLATE/custom.md | 17 +++++++++++++++++ 1 file changed, 17 insertions(+) create mode 100644 .github/ISSUE_TEMPLATE/custom.md diff --git a/.github/ISSUE_TEMPLATE/custom.md b/.github/ISSUE_TEMPLATE/custom.md new file mode 100644 index 0000000..ab3c496 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/custom.md @@ -0,0 +1,17 @@ +--- +name: Custom issue template +about: Describe this issue template's purpose here. +title: '' +labels: '' +assignees: '' + +--- + +# :white_check_mark: What's needed +*Describe what the subject asked you* + +## 📋 Subtasks +*Split this task up and create subtasks listed here* + +## :file_folder: Files required +*List all required files if any* From 3357ad847da97e9607c7de5f5f27f51a195fb930 Mon Sep 17 00:00:00 2001 From: 6im0n Date: Tue, 12 Mar 2024 00:53:35 +0100 Subject: [PATCH 2/3] =?UTF-8?q?=F0=9F=93=9D=20Add=20GitMoji=20commit=20con?= =?UTF-8?q?vention=20and=20contribution=20guidelines?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- CONTRIBUTING.md | 49 +++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 49 insertions(+) create mode 100644 CONTRIBUTING.md diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..45e90e3 --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,49 @@ +## GitMoji Commit Convention + +We use the GitMoji convention for our commit messages. Each commit message should start with an emoji, followed by a verb in present tense, and a brief description of what was done. Here are the emojis we use and their meanings: + +- ✨ for adding a feature +- ⚡ for improving a feature +- 🐛 for fixing a bug +- ✏️ for adding or updating headers or Makefile +- 🔀 for merging a branch into another +- 🚚 for changing the repository's structure (renaming or moving files) +- 🥅 for error handling +- ♻️ for Refactoring code in a better way +- 🚧 for work in progress +- 🔥 for removing code +- ⚰️ for removing deprecated/unused code +- 🚨 for fixing warnings +- 🎉 for initial commit +- 📝 for adding documentation +- ✅ for adding tests +- 🙈 for adding .gitignore +- 🔧 for adding or updating configuration files +- 🍱 for adding resources +- 🎨 for improving code structure/format +- 👷 for adding or updating files needed for continuous integration (CI) +- 🥚 for adding bonus or easter egg + + +Here's an example of a valid commit message: + +``` +✨ Add new feature to improve user experience +``` + +## Branching and Merging + +- Do not push directly to the main branch. +- Create a branch related to the current issue and make a pull request (PR) to merge the branch. +- At least one person must approve the PR before it can be merged. + +## Test Politics + +- Criterion + +## Code Quality + +- Always maintain high-quality code. + + +Thank you for contributing to the Haskell Image Compressor ! \ No newline at end of file From 22d098acd9d7fdc26a06c005742ee89744fdcbfc Mon Sep 17 00:00:00 2001 From: Simon <46846093+6im0n@users.noreply.github.com> Date: Tue, 12 Mar 2024 01:06:06 +0100 Subject: [PATCH 3/3] :memo: Update project description --- README.md | 23 ++++++++++++++++++++++- 1 file changed, 22 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 02f962f..02ed581 100644 --- a/README.md +++ b/README.md @@ -12,6 +12,27 @@ The Arcade project undertaken in the Second year at [{Epitech}](https://www.epit - [📦 Group remote repository](https://github.com/6im0n/Arcade) - [📄 PDF Project](https://intra.epitech.eu/module/2023/B-OOP-400/NAN-4-1/acti-633490/project/file/B-OOP-400_arcade.pdf) +### **📃 Description** + +Arcade is a **gaming platform**: +a program that lets the user choose a game to play and keeps a register of player scores. To be able to deal with the elements of your gaming plate-form at run-time, your graphics libraries and your games must be implemented as dynamic libraries, loaded at run-time. + +Each GUI available for the program must be used as a shared library that will be loaded and used dynamically by the main program +

+ +

+ + + +> [!CAUTION] +> It is **STRICTLY FORBIDDEN** to refer to a graphics library explicitly in your main program. Only your dynamic libraries can do so. This also applies to your games. + + +> [!NOTE] +> These dynamic libraries can be seen as plug-ins providing various capabilities to your main program. In **NO CASE** must graphics libraries influence the game logic. Game libraries must not contain any information about screen rendering or low-level events. + +> [!IMPORTANT] +> You MUST **NOT** differentiate your libraries. Each of your libraries MUST be handled in a generic and uniform manner. Keep genericity! ## **🎛️ Controls:** *Core:* @@ -31,7 +52,7 @@ The game was developed using the following technologies: ### **👨‍💻 Developer:** - [⛵ Kylian](https://github.com/Njord201) -- [🐟 Simon](https://github.com/ThomasQUINTIN) +- [🐟 Simon](https://github.com/6im0n) - [🦁 Quentin](https://github.com/Quentintnrl) ### **🍦 Design:**