Contributions

Thank you for your interest in contributing to the PBTrack project! We welcome contributions from everyone, and appreciate your efforts to make our framework better. If you are interested in contributing, please consider the following guidelines.

Getting Started

  1. Fork the repository: If you haven’t already, start by creating your own fork of the PBTrack repository. You can do this by clicking the “Fork” button on the repository page.

  2. Clone the repository: Clone your fork of the repository to your local machine using the git clone command. For example:

    git clone https://github.com/PbTrack/pb-track
    
  3. Set up your development environment: Follow the installation instructions to set up your development environment.

  4. Create a new branch: Create a new branch on your local machine for your changes. Use a descriptive name that summarizes the changes you’re making. For example:

    git checkout -b new-tracker
    

Making Changes

  1. Make your changes: Make your changes to the code in your local branch.

  2. Test your changes: Test your changes to make sure they work as expected.

  3. Commit your changes: Commit your changes with a descriptive commit message. For example:

    git commit -m "Add a new tracker"
    

Submitting Your Contribution

  1. Push your changes: Push your changes to your fork of the repository. For example:

    git push origin new-tracker
    
  2. Create a pull request: Go to the original PBTrack repository and create a pull request. Be sure to include a clear description of your changes and the problem they solve.

  3. Wait for feedback: A maintainer of the PBTrack repository will review your pull request and provide feedback.

  4. Merge your changes: Once your changes have been approved, a maintainer will merge them into the PBTrack repository.