Skip to content

Latest commit

 

History

History
49 lines (34 loc) · 1.54 KB

CONTRIBUTING.md

File metadata and controls

49 lines (34 loc) · 1.54 KB

Contributing to Project

Introduction

Thank you for considering contributing to our project! Your help is greatly appreciated. This document provides guidelines to help you contribute effectively.

Code of Conduct

Please read and follow our Code of Conduct to ensure a welcoming environment for all contributors.

How to Contribute

  1. Fork the Repository: Click the "Fork" button at the top right of the repository page.
  2. Clone Your Fork: Clone your forked repository to your local machine.
git clone https://github.com/your-username/Directory-Tree.git
  1. Create a Branch: Create a new branch for your changes.
git checkout -b feature/your-feature-name
  1. Make Changes: Make your changes to the codebase.
  2. Commit Changes: Commit your changes with a descriptive commit message.
git commit -m "Description of your changes"
  1. Push Changes: Push your changes to your forked repository.
git push origin feature/your-feature-name
  1. Create a Pull Request: Open a pull request to the main repository.

Style Guides

  • Python: Follow PEP 8 guidelines.
  • C++: Follow the Google C++ Style Guide.

Testing

Ensure that your changes do not break existing tests and add new tests if necessary.

  1. Add Tests: Add new tests in the Tests directory.

Issue Reporting

If you find a bug or have a feature request, please open an issue on GitHub. Provide as much detail as possible to help us understand and address the issue.

Thank you for contributing!