# CONTRIBUTING

Thank you for considering contributing to my humble project! It's very kind. 
However, be sure to read the code of conduit and guidelines before to contribute.
*You can find them in the management folder.*

## How to file a bug report?
Go in **issues**, then click on **new issue** and select **bug report**

## How to suggest a new feature?
Go in **Discussions**. Any suggestion is welcome! Of course, everything isn't
 possible, but giving your opinion or thought about improving this project is good.

## How to propose your modifications?
1. Fork my project
2. Commit to your repository
3. Open a pull request on the `Develop` branch on my repository
4. Grab a drink and wait for my review (You can expect me to acknowledge it in a few days)
5. Discuss / edit your pull request with me if needed
6. Get merged! :D
7. Get credited. UwU

## How to set up your environment and run tests?
You will need [Godot Engine](https://godotengine.org/download) installed.
Then clone the repository and open it with Godot Engine.

## The types of contributions I'm looking for
I **really need help designing the user interface** but as long as you feel useful to
contribute, do so! You can contribute by making some doc, scripts, Github actions, 
giving some design advice or even suggestions.

## How can you get in touch with me?
You can start a discussion in the **discussions** tab or you can join my 
[Discord server](https://discord.gg/hSey9Bv).
If you are more old school you can send me an email at lyaaaaaaaaaaaaaaa@protonmail.com :).

## Useful resources

- [Software_Architecture](https://github.com/Lyaaaaaaaaaaaaaaa/Logs_Filter_2/blob/Master/management/software_architecture.png)
- [Code rules](https://github.com/Lyaaaaaaaaaaaaaaa/Logs_Filter_2/blob/Master/management/code_rules.md)
- [Class diagram](https://github.com/Lyaaaaaaaaaaaaaaa/Logs_Filter_2/blob/Master/management/class_diagram.png)
