Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
38 lines (27 loc) · 2.68 KB

CONTRIBUTING.md

File metadata and controls

38 lines (27 loc) · 2.68 KB

Contributing to TPEInteractive

Thank you for your interest in contributing to TPEInteractive! We welcome contributions in various forms, including bug reports, feature requests, documentation improvements, and code submissions.

Reporting Issues

  • Bugs: If you encounter a bug, please check the existing issues first to see if it has already been reported. If not, please file a new bug report using the provided template. Include detailed steps to reproduce the issue, your runtime environment, and any relevant screenshots or error messages.
  • Features: If you have an idea for a new feature or an enhancement, please check the existing issues to see if it has been suggested. If not, please file a new feature request.

Code Contributions (Pull Requests)

  1. Fork the Repository: Create your own fork of the main repository on GitHub.
  2. Create a Branch: Create a new branch in your fork for your changes (e.g., git checkout -b feature/my-new-feature or git checkout -b fix/fix-gizmo-bug).
  3. Make Changes: Implement your feature or bug fix.
    • Adhere to the existing code style (try to maintain consistency).
    • Add comments to explain complex logic.
    • Ensure the code builds successfully using CMake.
    • (Optional but encouraged) Add tests if applicable.
  4. Commit Changes: Make clear and concise commit messages.
  5. Push Changes: Push your branch to your fork on GitHub (git push origin feature/my-new-feature).
  6. Open a Pull Request: Go to the main TPEInteractive repository on GitHub and open a pull request from your branch to the main development branch (e.g., main or develop).
    • Provide a clear description of the changes in the pull request.
    • Reference any related issues (e.g., "Fixes #123").
  7. Code Review: Wait for project maintainers to review your code. Address any feedback or requested changes.
  8. Merge: Once approved, your pull request will be merged.

Code Style

(Optional: Define basic style guidelines here, e.g., variable naming conventions, brace style, comment requirements)

  • Try to follow the formatting and naming conventions present in the existing codebase.
  • Use clang-format if a configuration file (.clang-format) is provided in the repository.

Questions?

If you have questions about contributing or the codebase, feel free to open an issue with the "question" label.

Thank you for contributing!