Skip to content

Latest commit

 

History

History
87 lines (60 loc) · 2.9 KB

CONTRIBUTING.md

File metadata and controls

87 lines (60 loc) · 2.9 KB

Contribution Guidelines

Table of Contents

Introduction

Thank you for considering contributing to this project! We welcome contributions from everyone. This document provides guidelines for contributing to this project.

Getting Started

If you are new to contributing to open source projects, you may find the following resources helpful:

To get started with contributing to this project, please follow these steps:

  1. Fork the repository to your own GitHub account.
  2. Clone the forked repository to your local machine.
  3. Create a new branch for your changes: 
    git checkout -b my-feature-branch
  4. Make your changes and commit them with descriptive commit messages.
  5. Push your changes to your forked repository: 
    git push origin my-feature-branch
  6. Create a pull request from your forked repository to the main project repository.

Contributing

We welcome contributions in various forms, including:

  • Bug reports and fixes
  • Feature requests and implementations
  • Documentation improvements
  • Code refactoring and optimizations
  • New models
  • New Dataset references

When contributing code changes, please ensure that you:

  • Follow the coding style and conventions used in the project.
  • Write clear, concise, and well-documented code.
  • Include unit tests for new functionality.
  • Update the documentation, if necessary.

Issues

If you encounter any issues or have suggestions for improvements, please create a new issue in the project's issue tracker. When creating an issue, please provide as much detail as possible, including:

  • A clear and descriptive title.
  • Steps to reproduce the issue, if applicable.
  • Expected behavior and actual behavior.
  • Any relevant error messages or screenshots.

Pull Requests

When submitting a pull request, please ensure that you:

  • Provide a clear and descriptive title.
  • Include a detailed description of the changes made.
  • Reference any related issues or pull requests.
  • Have thoroughly tested your changes.

All pull requests will be reviewed by the project maintainers. They may provide feedback or request changes before merging the pull request.

Code of Conduct

Please note that this project has a Code of Conduct. By participating in this project, you agree to abide by its terms.

License

By contributing to this project, you agree that your contributions will be licensed under the LICENSE file in the root directory of this project.

Thank you for your contributions and helping to make this project better!