Skip to content

Latest commit

 

History

History
36 lines (25 loc) · 2.08 KB

CONTRIBUTING.md

File metadata and controls

36 lines (25 loc) · 2.08 KB

Contributing Guidelines

Thank you for your interest in contributing to our project. We appreciate your help in making this project better for everyone. Please take a moment to review the following guidelines to ensure a smooth and productive collaboration.

Code of Conduct

We adhere to a Code of Conduct to ensure a welcoming and inclusive environment for all contributors. Please review our Code of Conduct before participating in this project.

How to Contribute

We welcome contributions in various forms, including bug reports, feature requests, documentation improvements, and code contributions. Here's how you can get involved:

Submitting Pull Requests

If you would like to contribute code or documentation changes, please follow these steps:

  1. Fork the repository to your own GitHub account.
  2. Create a new branch for your work: git checkout -b feature/your-feature-name or bugfix/your-bugfix-name.
  3. Make your changes and commit them.
  4. Push your branch to your fork: git push origin feature/your-feature-name.
  5. Open a pull request to our repository, explaining the purpose and details of your changes.
  6. Please ensure your pull request follows our Commit Message Guidelines.

Getting Started

To get started with contributing, please follow these steps:

  1. Read our Code of Conduct to understand the expectations of behavior within this project.
  2. Fork the repository to your GitHub account.
  3. Clone your fork to your local development environment.
  4. Follow the Development Environment Setup to prepare your environment.
  5. Check out our Coding Guidelines for information on coding standards and best practices

Testing

Before submitting code changes, it's essential to test your work thoroughly. Ensure that your changes don't break existing functionality and that new features work as expected. Follow the testing guidelines outlined in TESTING.md.

Documentation

Contributions to documentation are highly valued. If you make changes to the project's documentation, ensure that your additions are clear and concise. Also, update the relevant sections of this CONTRIBUTING.md document.