Skip to content

Latest commit

 

History

History
70 lines (49 loc) · 3.93 KB

CONTRIBUTING.md

File metadata and controls

70 lines (49 loc) · 3.93 KB
Raw

Contributing Guidelines

Welcome to our open source project! We appreciate your interest in contributing to our project. Please take a moment to review these guidelines before making a contribution to ensure a smooth and successful collaboration.

Ways to Contribute

There are many ways to contribute to our project. You can:

  • Report issues and bugs
  • Suggest new features or improvements
  • Submit bug fixes or code contributions

Code of Conduct

We expect all contributors to adhere to our code of conduct to ensure a respectful and inclusive environment for everyone. Our code of conduct can be found in the CODE_OF_CONDUCT file.

How to Contribute

Contributions are always welcome! Please follow these steps:

  1. Fork the project repository. This creates a copy of the project on your account that you can modify without affecting the original project.
  2. Clone the forked repository to your local machine using a Git client like Git or GitHub Desktop.
  3. Create a new branch with a descriptive name (e.g., new-feature-branch or bugfix-issue-123).
git checkout -b new-feature-branch/add-some-feature
  1. Make changes to the project's codebase.
  2. Commit your changes to your local branch with a clear commit message that explains the changes you've made.
git commit -m 'Implemented new feature.'
  1. Push your changes to your forked repository on GitHub using the following command
git push origin new-feature-branch/add-some-feature
  1. Create a pull request to the original repository.

Open a new pull request to the original project repository. In the pull request, describe the changes you've made and why they're necessary. The project maintainers will review your changes and provide feedback or merge them into the main branch.

Reporting Issues and Bugs

If you find an issue or bug in our project, please report it by opening a new issue in the project's issue tracker. Please include a clear description of the issue or bug, as well as any relevant code or error messages.

Suggesting New Features or Improvements

If you have an idea for a new feature or improvement to our project, please suggest it by opening a new issue in the project's issue tracker. Please include a clear description of the feature or improvement you are suggesting, as well as any relevant examples or use cases.

Submitting Bug Fixes or Code Contributions

If you would like to contribute code to our project, please follow these guidelines:

  • Before making a contribution, please discuss your proposed changes with the project maintainers to ensure they align with the project's goals and direction.
  • Please write clear, well-documented code that adheres to the project's coding style and standards.
  • Please write unit tests for any new code contributions or changes to ensure they are working correctly and do not break existing functionality.
  • Please ensure your code is properly formatted and free of any linting errors or warnings.
  • Please commit your changes with clear and descriptive messages that explain what you have done.
  • Please ensure your changes are rebased onto the latest version of the main project branch before submitting a pull request.
  • Please ensure your pull request includes a clear description of the changes you have made and why they are necessary or beneficial.

Code Reviews

All contributions to our project will be reviewed by project maintainers before they are merged into the main project branch. Reviews may include feedback on the code, suggestions for improvement, or requests for additional testing or documentation.

Attribution

Contributors to our project will be acknowledged in the project's README.md file and AUTHORS.md file.

License

By contributing to our project, you agree to license your contributions under the project's open source license. The project's license can be found in the LICENSE.md file.

Thank you for contributing to our project!