Skip to content

Contributing

Please take a moment to review this document for guidelines on how to contribute effectively.

Table of Contents

Code of Conduct

Please note that this project has adopted a Code of Conduct. By participating in this project, you are expected to uphold this code of conduct. Please report any unacceptable behavior to project maintainers.

How Can I Contribute?

Reporting Bugs

If you encounter a bug or an issue with the project, please open a new issue on our GitHub repository. When reporting a bug, please include as much detail as possible, including your operating system and a clear description of the problem.

Suggesting Enhancements

We welcome your suggestions for improving the project. If you have an idea for an enhancement or new feature, please create an enhancement request on GitHub. Describe the feature you'd like to see and how it would benefit the project.

Creating Pull Requests

Contributions in the form of code changes, bug fixes, or new features are greatly appreciated! To contribute, please follow these steps:

  1. Fork the repository to your GitHub account.

  2. Clone the forked repository to your local machine:

git clone git@github.com:EpitechPromo2026/B-CPP-500-PAR-5-1-rtype-julian.emery.git

Create a new branch for your work:

git checkout -b feature/your-feature-name
  • Make your code changes, following our coding guidelines.

Commit your changes with descriptive commit messages:

git commit -m "[ADD]: your feature description"

Push your branch to your forked repository:

git push origin feature/your-feature-name

  • Open a Pull Request against the main repository. Be sure to provide a clear title and description of your changes.

  • Participate in the code review process, addressing feedback and making necessary changes.

  • Once approved by reviewers and all checks pass, a project collaborator will merge your Pull Request into the main branch.

Please be patient during the review process, and thank you for your contribution! Development Setup

If you'd like to set up the project for local development, follow our development setup guide for detailed instructions on how to get started. Coding Guidelines

To maintain code quality and consistency, please adhere to our coding guidelines when making changes to the project. Commit Message Guidelines

We follow a set of commit message guidelines to keep our commit history clean and informative. Please review these guidelines before making commits.

By contributing to this project, you agree that your contributions will be licensed under the LICENSE of this project.