Skip to content

Code of Conduct

We are committed to providing a friendly, welcoming, and inclusive environment for all contributors to this project. By participating in this project, you agree to abide by this code of conduct.

How to Contribute

We appreciate your contributions! To help you get started, here are the steps you can follow:

  1. Fork the repository
    Fork the repository to your personal GitHub account to make changes.

  2. Create a new branch
    Always create a new branch for your work, whether you're fixing a bug, adding a new feature, or updating documentation.

  3. Make your changes
    Implement your changes, keeping the code clean, well-organized, and following any existing patterns and style guidelines.

  4. Commit your changes
    Write clear, concise commit messages that describe what you've done. Use the present tense (e.g., "Fix bug" rather than "Fixed bug").

  5. Push your changes to your fork
    Push the changes to your personal fork on GitHub.

  6. Create a pull request
    Once you're ready, open a pull request to propose your changes. Make sure your pull request follows the guidelines below:

  7. Write tests: Add relevant unit tests to cover your changes. Unit tests are an essential part of our process and help ensure stability and correctness.

  8. Do developer testing: Before submitting your pull request, thoroughly test your changes in the development environment.

  9. Update documentation: If your changes affect functionality or introduce new features, please update the documentation accordingly to reflect those changes.

Additional Guidelines

  • Respect others: Treat all participants with kindness, respect, and empathy. We foster a collaborative and inclusive community.

  • Be open to feedback: Code reviews are a valuable process for improving the quality of the project. Be open to suggestions and critique.

  • No harassment: Harassment, offensive behavior, and discrimination are not tolerated. If you witness or experience inappropriate conduct, please report it immediately.

By following these guidelines, we can maintain a productive and positive environment for all contributors.

Thank you for contributing to our project!