Contributing to Our Project

Welcome!

We're thrilled you're interested in contributing to our project. This guide will walk you through the process of getting started and making a valuable contribution.

Getting Started

  1. Read Our Code of Conduct - Understanding our community guidelines is crucial.
  2. Report an Issue - Before you start working on a feature or fix, let us know about it.
  3. Set Up Your Development Environment - Ensure you have the necessary tools installed.

Code of Conduct

We maintain a strict Code of Conduct to ensure a welcoming and respectful environment for all contributors. Please review it carefully before submitting any code or suggestions: /code-of-conduct.html

Reporting Issues

If you find a bug or have a suggestion for improvement, please report it before starting work. This helps us understand the scope of the problem and avoid duplicating efforts.

You can report an issue on GitHub.

Setting Up Your Development Environment

We primarily use Git and GitHub for version control. You'll need a Git client installed on your machine. Here are the recommended tools:

Making Your Contribution

Once you've set up your environment, you can:

  1. Create a new branch for your feature or fix.
  2. Make your changes.
  3. Commit your changes with descriptive messages.
  4. Push your branch to your forked repository on GitHub.
  5. Create a Pull Request (PR) to merge your changes into the main branch.

Resources