Add files to be an open source project

CONTRIBUTING.md

@@ -0,0 +1,72 @@
+# Contributing to Jeu-De-Piste-Michelin
+
+First off, thanks for taking the time to contribute! 🎉
+
+The following is a set of guidelines for contributing to Jeu-De-Piste-Michelin. These are mostly guidelines, not rules. Use your best judgment, and feel free to propose changes to this document in a pull request.
+
+### Code of Conduct
+
+This project and everyone participating in it is governed by the [Code of Conduct](./code_of_conduct.md). By participating, you are expected to uphold this code. Please report unacceptable behavior to (see the contact mail on the README.md).
+
+## How Can I Contribute?
+
+### Reporting Bugs
+
+This section guides you through submitting a bug report for Jeu-De-Piste-Michelin. Following these guidelines helps maintainers and the community understand your report, reproduce the behavior, and find related reports.
+
+- **Ensure the bug was not already reported** by searching on GitHub under [Issues](https://github.com/michelin/treasure-hunt/issues).
+- If you're unable to find an open issue addressing the problem, [open a new one](https://github.com/michelin/treasure-hunt/issues/new). Be sure to include **[BUG] following by a title and a clear description**, as much relevant information as possible, and a **code sample** or an **executable test case** demonstrating the expected behavior that is not occurring.
+
+### Suggesting Enhancements
+
+This section guides you through submitting an enhancement suggestion for Jeu-De-Piste-Michelin, including completely new features and minor improvements to existing functionality.
+
+- **Check if the feature is already requested** by searching on GitHub under [Issues](https://github.com/michelin/treasure-hunt/issues).
+- If the enhancement is not already listed, [open a new issue](https://github.com/michelin/treasure-hunt/issues/new). Please include a **[REQUEST] following by a descriptive title** and as much detail as possible.
+
+### Your First Code Contribution
+
+Unsure where to begin contributing to Jeu-De-Piste-Michelin? Here are a few ways you can get started:
+
+- Look through the [issues](https://github.com/michelin/treasure-hunt/issues) to find bugs or feature requests that interest you.
+- Participate in discussions on existing issues to get more context and provide your input.
+- Review the project documentation to understand the codebase and see if there are any areas that need improvement or clarification. (especially api.py an static-generator.py)
+
+If you're new to contributing, you might want to start with smaller tasks or bug fixes to familiarize yourself with the project. Feel free to ask for guidance or clarification on any issue by leaving a comment.
+
+### Pull Requests
+
+The process described here has several goals:
+
+- Maintain Jeu-De-Piste-Michelin's quality
+- Fix problems that are important to users
+- Engage the community in working toward the best possible Jeu-De-Piste-Michelin
+- Enable a sustainable system for Jeu-De-Piste-Michelin's maintainers to review contributions
+
+Please follow these steps to have your contribution considered by the maintainers:
+
+1. **Fork** the repository.
+2. **Clone** your fork to your local machine.
+3. **Create a branch**: `git checkout -b my-branch-name`.
+4. **Make your changes** and **commit** them: `git commit -m 'Add some feature'`.
+5. **Push** to your forked repository: `git push origin my-branch-name`.
+6. **Submit a pull request**: You can use the GitHub interface to do this.
+
+## Style Guides
+
+### Git Commit Messages
+
+- Use the present tense ("Add feature" not "Added feature").
+- Use the imperative mood ("Move cursor to..." not "Moves cursor to...").
+- Limit the first line to 72 characters or less.
+- Reference issues and pull requests liberally after the first line.
+
+### Code Style
+
+- Follow the style guides of the programming language you're using.
+- Ensure your code passes all tests and is linted correctly.
+
+## Additional Resources
+
+- [Issue Tracker](https://github.com/michelin/treasure-hunt/issues)
+- [Pull Requests](https://github.com/michelin/treasure-hunt/pulls)

code_of_conduct.md

@@ -0,0 +1,133 @@
+
+# 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, caste, color, 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 email 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
+(see contact method on README.md).
+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.1, available at
+[https://www.contributor-covenant.org/version/2/1/code_of_conduct.html][v2.1].
+
+Community Impact Guidelines were inspired by
+[Mozilla's code of conduct enforcement ladder][Mozilla CoC].
+
+For answers to common questions about this code of conduct, see the FAQ at
+[https://www.contributor-covenant.org/faq][FAQ]. Translations are available at
+[https://www.contributor-covenant.org/translations][translations].
+
+[homepage]: https://www.contributor-covenant.org
+[v2.1]: https://www.contributor-covenant.org/version/2/1/code_of_conduct.html
+[Mozilla CoC]: https://github.com/mozilla/diversity
+[FAQ]: https://www.contributor-covenant.org/faq
+[translations]: https://www.contributor-covenant.org/translations