Skip to content

Latest commit

 

History

History
86 lines (54 loc) · 2.74 KB

CONTRIBUTING.md

File metadata and controls

86 lines (54 loc) · 2.74 KB

Contributing to Trackifly

Thank you for considering contributing to Trackifly! We welcome contributions that help improve the project. Please read this guide to ensure your contribution is as smooth as possible.

How to Contribute

1. Fork the Repository

To contribute to the project, you'll need to fork this repository and create a new branch to make your changes. Here's how you can do that:

  • Click the Fork button at the top-right corner of this repository.
  • Clone your fork locally:
git clone https://github.com/lksmasin/trackifly.git
cd trackifly

2. Create a Branch

Before making any changes, create a new branch for your work:

git checkout -b feature/your-feature-name

3. Make Your Changes

Work on the project, making any necessary changes or additions. Some common types of contributions might include:

  1. Bug fixes
  2. Feature additions
  3. Code optimizations
  4. Documentation improvements

4. Test Your Changes

Before submitting your changes, ensure that all existing tests pass and that your changes work as expected. You can run the test suite using the following command:

flutter test

5. Commit Your Changes

Once you're happy with your changes, commit them to your branch:

git add .
git commit -m "Describe your changes"

6. Push Your Changes

Push your changes to your fork on GitHub:

git push origin feature/your-feature-name

7. Create a Pull Request

After pushing your changes, go to the original repository and create a pull request (PR) from your fork. Provide a clear description of your changes and reference any issues they address (if applicable).

8. Review and Discussion

Once you've created the PR, the maintainers will review your changes. They may request changes or suggest improvements. Please respond to feedback in a timely manner and update your pull request accordingly.

Code of Conduct

By participating in this project, you agree to abide by the Code of Conduct.

Reporting Issues

If you encounter any bugs or have suggestions for improvements, please report them by opening an issue in the issues section.

Please provide as much detail as possible, including:

  1. Steps to reproduce the issue
  2. Expected behavior vs. actual behavior
  3. Screenshots or error messages (if applicable)

License

By contributing to this project, you agree that your contributions will be licensed under the MIT License.

Thank You!

Thank you for contributing to Trackifly! Your contributions help improve the project and make it even better for everyone. Happy coding! 🎉