contributing.md

Contributing

Contributions are welcome! Follow these guidelines to contribute to Tracktor.

Getting Started

1. Fork the repository on GitHub
2. Clone your forked repository to your local machine
3. Create a new branch for your feature or bug fix
4. Make your changes with clear, descriptive commit messages
5. Run tests to ensure everything works
6. Run the linter to maintain code quality
7. Push your changes to your forked repository
8. Open a pull request against the dev repository

Development Workflow

Running Tests

pnpm run test

Linting and Formatting

pnpm run lint
pnpm run format

Guidelines

• Follow the project's coding standards
• Include appropriate tests for new features
• Write clear commit messages
• Update documentation when necessary
• Ensure all tests pass before submitting a pull request

Code Quality

All contributions should maintain or improve code quality. Run linting and formatting tools before committing changes.

License

This project is licensed under the MIT License. See the LICENSE file for details.

Contact

For questions or assistance, contact the project maintainer at javedh.dev@gmail.com.