Skip to content

Latest commit

 

History

History
59 lines (39 loc) · 2.09 KB

CONTRIBUTING.md

File metadata and controls

59 lines (39 loc) · 2.09 KB

Contributing to SLAM Tools Repository

Thank you for considering contributing to the SLAM Tools Repository! We welcome contributions from the community to help improve and expand this collection of SLAM algorithms.

How to Contribute

  1. Fork the Repository: Create a personal fork of the repository on GitHub.

  2. Clone Your Fork: Clone your fork to your local machine.

    git clone https://github.com/yourusername/slam-tools.git
cd slam-tools   ```

  3. Create a Branch: Create a new branch for your feature or bug fix.

    git checkout -b feature/your-feature-name   ```

  4. Make Changes: Implement your changes, ensuring they are well-documented and tested.

  5. Commit Changes: Commit your changes with a clear and descriptive message.

    git commit -m "Add feature: description of your feature"   ```

  6. Push to GitHub: Push your changes to your fork on GitHub.

    git push origin feature/your-feature-name   ```

  7. Submit a Pull Request: Open a pull request to the main repository with a clear description of your changes.

Coding Style

  • Use consistent naming conventions (e.g., camelCase for variables and functions, PascalCase for classes).
  • Indent using spaces (2 or 4 spaces).
  • Limit lines to 80-100 characters.
  • Use meaningful and descriptive names for variables and functions.

Documentation

  • Comment your code to explain complex logic.
  • Use Doxygen-style comments for functions and classes.
  • Update the README or other documentation files if your changes affect usage or setup.

Testing

  • Ensure your code is well-tested.
  • Write unit tests for new features or changes.
  • Run all tests before submitting a pull request.

Pull Request Guidelines

  • Provide a clear description of the changes made.
  • Reference any related issues or discussions.
  • Be open to feedback and willing to make changes.

Licensing

  • Ensure that any third-party code or libraries used are compatible with the project's license.

We appreciate your contributions and look forward to collaborating with you to improve the SLAM Tools Repository!