Skip to content

Latest commit

 

History

History
72 lines (45 loc) · 4.01 KB

CONTRIBUTING.md

File metadata and controls

72 lines (45 loc) · 4.01 KB
Raw

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. 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.
  • If you're unable to find an open issue addressing the problem, open a new one. 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.
  • If the enhancement is not already listed, open a new issue. 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 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