Skip to content

Latest commit

 

History

History
38 lines (24 loc) · 1.74 KB

CONTRIBUTING.md

File metadata and controls

38 lines (24 loc) · 1.74 KB
Raw

Contributing to synTrack

Thank you for your interest in contributing to synTrack! We welcome contributions from anyone ❤️

How to Contribute

To contribute to synTrack, you can follow these steps:

  1. Fork the repository on Github.
  2. Clone your forked repository to your local machine.
  3. Create a new branch for your changes: git checkout -b my-new-feature.
  4. Make your changes and commit them: git commit -am 'Add some feature'.
  5. Push your changes to your forked repository: git push origin my-new-feature.
  6. Create a pull request from your branch to the main branch of the original repository on Github.

Please make sure to follow the Code of Conduct and License when contributing to synTrack.

Code Style

To ensure consistency and readability, please follow the Dart Style Guide.

Bug Reports

If you find a bug in synTrack, please open an issue on Github with a detailed description of the bug and steps to reproduce it. Please include any relevant code, error messages, and screenshots if applicable.

Feature Requests

If you have an idea for a new feature or improvement to synTrack, please open an issue on Github with a detailed description of the feature or improvement. Please include any relevant mockups, diagrams, or other visuals if applicable.

Pull Requests

We welcome pull requests from anyone! When creating a pull request, please:

  • Explain the changes you've made and why they're necessary.
  • Make sure your code follows the code style guidelines.
  • Make sure your code passes all tests and does not introduce any new bugs.
  • Include any relevant documentation updates.
  • Include screenshots or other visuals if applicable.