Skip to content

Latest commit

 

History

History
70 lines (40 loc) · 2.56 KB

CONTRIBUTING.md

File metadata and controls

70 lines (40 loc) · 2.56 KB
Raw

Contributing to DimSense

Thank you for your interest in contributing to DimSense! We welcome contributions from the community to help improve and enhance our library. Whether you want to fix a bug, add a new feature, or improve documentation, your contributions are valuable.

Getting Started

  1. Fork the repository by clicking the "Fork" button at the top right of this page.

  2. Clone your forked repository to your local machine:

    git clone https://github.com/yourusername/DimSense.git
cd DimSense

  3. Create a new branch for your work:

    git checkout -b your-feature-or-bug-fix

Making Changes

  • Make the necessary changes to the codebase, documentation, or tests according to your contribution.

  • Ensure your changes follow the coding style and best practices of the project.

  • Add meaningful commit messages that describe your changes.

Testing

  • Run the existing tests using the following command:

    pytest

  • If you're adding new functionality, consider adding new test cases to cover your changes.

Submitting a Pull Request

  1. Push your changes to your forked repository:

    git push origin your-feature-or-bug-fix

  2. Visit your forked repository on GitHub and click the "Compare & pull request" button.

  3. Provide a clear title and description for your pull request. Explain the purpose of your changes and any relevant details.

  4. Submit the pull request! Our team will review your contribution, provide feedback, and work with you to get your changes merged into the main repository.

Code of Conduct

By participating in this project, you agree to abide by the Code of Conduct. We expect all contributors to follow this code in all interactions within the project community.

Questions or Assistance

If you have any questions, encounter issues, or need assistance, please feel free to reach out to us via GitHub issues or by contacting handanfoun@gmail.com.

Community

Discussions about the Open Source Guides take place on this repository's Issues and Pull Requests sections. Anybody is welcome to join these conversations.

Wherever possible, do not take these conversations to private channels, including contacting the maintainers directly. Keeping communication public means everybody can benefit and learn from the conversation.

Thank you for your contribution!

— The DimSense Team