Skip to content

Latest commit

 

History

History
85 lines (52 loc) · 2.77 KB

CONTRIBUTING.md

File metadata and controls

85 lines (52 loc) · 2.77 KB

Contributing to flutter_file_info

Thank you for your interest in contributing to flutter_file_info! We welcome contributions from the community to help improve and extend the plugin.

How to Contribute

Reporting Issues

If you encounter a bug or have a feature request, please follow these steps:

  1. Check Existing Issues: Before submitting a new issue, please check the existing issues to see if your issue has already been reported or addressed.

  2. Submit a New Issue:

  • Go to the Issues page.
  • Click on the "New Issue" button.
  • Provide a clear and descriptive title for the issue.
  • Include detailed steps to reproduce the issue, along with any relevant code snippets or error messages.
  • Specify the platform (Android, iOS, Windows, etc.) and any other relevant information.

Contributing Code

We welcome contributions in the form of bug fixes, new features, and improvements. To contribute code, please follow these steps:

  1. Fork the Repository:

    • Click on the "Fork" button at the top right of this repository's GitHub page to create a copy of the repository in your own GitHub account.

  2. Clone Your Fork:

    • Clone your forked repository to your local machine using:
    git clone https://github.com/yourusername/flutter_file_info.git

  3. Create a New Branch:

    • Create a new branch for your changes:
    git checkout -b your-branch-name

  4. Make Your Changes:

    • Make your changes or additions to the codebase.
    • Ensure that your code adheres to the existing coding style and includes appropriate comments.

  5. Test Your Changes:

    • Run tests to ensure your changes don’t break existing functionality and that they work as expected.

  6. Commit Your Changes:

    • Use Conventional Commits to format your commit messages. This standard helps with versioning and changelog generation.
    • Commit your changes with a message that describes the modification:
    git add .
git commit -m "type: short description of the change"

  7. Push Your Changes:

    • Push your changes to your forked repository:
    git push origin your-branch-name

  8. Create a Pull Request:

    • Go to the Pull Requests page of the original repository.
    • Click on the "New Pull Request" button.
    • Select your branch and provide a clear description of the changes you made.
    • Submit the pull request.

Review Process

Once you submit a pull request, I will review it and provide feedback if necessary. We may request changes before merging your pull request. Please be patient and responsive to any feedback provided.

Thank You

We appreciate your contributions and thank you for helping to improve flutter_file_info!