Skip to content

Latest commit

 

History

History
65 lines (41 loc) · 2.43 KB

CONTRIBUTING.md

File metadata and controls

65 lines (41 loc) · 2.43 KB
Raw

Contributing

Thank you for your interest in contributing! We appreciate your help in making this project better. Before you start contributing, please take a moment to review the following guidelines to ensure a smooth and effective collaboration.

Code of Conduct

Please review our Code of Conduct to understand the expected behavior in our community. We expect all contributors to adhere to these guidelines when participating in the project.

How to Contribute

Contributing is a straightforward process. Here are the general steps to follow:

  • Fork the Repository: Start by forking the repository to your GitHub account.

  • Clone the Repository: Clone the forked repository to your local machine.

  • Create a Branch: Before making changes, create a new branch with a descriptive name for your feature or bug fix:

git checkout -b feature/my-new-feature

  • Use the feature/ prefix for adding new features and bug/ prefix for bug fixes.

  • Make Changes: Implement your changes, following the coding conventions and best practices of the project.

  • Test Your Changes: Thoroughly test your changes to ensure that they work as expected and do not introduce any regressions.

  • Commit Your Changes: Once you're satisfied with your changes, commit them with a meaningful commit message:

git add .
git commit -m "Add my new feature"
  • Push Your Changes: Push the changes to your forked repository:
git push origin feature/my-new-feature

  • Create a Pull Request: Go to the original repository on GitHub and create a Pull Request (PR) from your branch to develop branch. Make sure to provide a clear and detailed description of your changes in the PR.

  • Code Review: The project maintainers will review your PR. Please be patient during this process, and be prepared to address any feedback or requests for changes.

  • Merge and Release: If your PR is approved, it will be merged into the develop branch, and your changes will be included in the next release.

Reporting Issues

If you encounter any bugs, have feature requests, or want to suggest improvements, please feel free to open an issue on GitHub. When reporting an issue, provide as much detail as possible to help us understand and reproduce the problem.

License

By contributing, you agree that your contributions will be licensed under the BSD 3-Clause License.

Happy Contributing!