Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

📝 Update and add documentation #1

Merged
merged 3 commits into from
Mar 19, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
17 changes: 17 additions & 0 deletions .github/ISSUE_TEMPLATE/custom.md
Original file line number Diff line number Diff line change
@@ -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*
49 changes: 49 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -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 !
23 changes: 22 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
<p align="center">
<img width="250" height="200" src="https://github.com/6im0n/Arcade/assets/46846093/eea8429e-e899-4f50-9434-2d2c9e0abf7e">
</p>



> [!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:*
Expand All @@ -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:**
Expand Down
Loading