Contributing to OrbDot

Thank you for your interest in contributing to OrbDot! Your feedback, bug reports, and code contributions are always welcome. If you have any questions or concerns, feel free to reach out via email: shagey@phas.ubc.ca

Bug Reports and Feature Requests

If you encounter a bug or unexpected behavior, please open an issue on GitHub. When submitting an issue, please provide as much relevant information as possible, including:

  • A clear and descriptive title.

  • A minimal code snippet that reproduces the issue (if applicable).

  • Any additional details that might help diagnose the problem, such as your system information (e.g., OS, Python version, and dependencies).

To make this process easier, a bug report template is available. Simply copy the contents of the appropriate template, modify it to demonstrate the issue, and paste it into the issue description.

If you would like to suggest a new feature, please open a GitHub issue using the feature request template.

Fixing Bugs

If you’ve fixed a bug, thank you! To submit your fix:

  1. Open a new pull request on GitHub

  2. Ensure the description clearly explains the problem and the solution

  3. If the bug was reported in an issue, reference the issue number to help track the fix

Contributing Code

We welcome contributions in the form of bug fixes, new features, and documentation improvements! To contribute:

  1. Fork and Clone the Repository

    • First, fork the OrbDot repository and clone it to your local machine

    • Keep your local main branch up-to-date with the repository to avoid conflicts

  2. Create a Development Branch

    • Create a new branch with a descriptive name

  3. Write and Test Your Code

    • Include comments and docstrings in NumPy style

    • Test your changes to ensure they work as expected

  4. Submit a Pull Request

    • When you’re ready, open a pull request on GitHub

    • Provide a clear summary of your changes and how they improve OrbDot

    • If your PR addresses an open issue, reference the issue number to help track the fix

    • A pull request template is available to guide you through the process