Skip to content

PR_guide.md

Latest commit

 

History

History
49 lines (25 loc) · 2.45 KB

PR_guide.md

File metadata and controls

49 lines (25 loc) · 2.45 KB

Pull Request Guidelines

Thank you for contributing to our Flutter package! Before submitting your pull request, please make sure to follow these guidelines to ensure smooth review and integration.

Code Quality

  • Follow Flutter Best Practices: Ensure your code adheres to the best practices outlined in the Flutter documentation.

  • Consistency: Maintain consistency with existing code style, naming conventions, and formatting.

  • Modularity: Break down your changes into small, logical commits with clear messages.

  • Testing: Write unit tests to cover your changes and ensure existing tests pass. New features or bug fixes should have corresponding test cases.

Documentation

  • API Documentation: Update the API documentation and comments to reflect any changes made.

  • README: If your changes affect the package's usage or behavior, update the README with relevant information, usage examples, or any necessary installation instructions.

Compatibility and Dependencies

  • Flutter Version: Ensure your changes are compatible with the supported Flutter versions specified in the package's pubspec.yaml.

  • Dependency Management: Avoid introducing new dependencies unless absolutely necessary. If you do, provide a clear justification for their inclusion.

Pull Request Description

  • Title: Provide a concise and descriptive title for your pull request that summarizes the changes.

  • Description: In the description, provide more details about the changes, why they are necessary, and any potential side effects or considerations for reviewers.

  • Related Issues: If your pull request addresses any open issues, reference them using GitHub's issue linking syntax (e.g., "Fixes #123").

Review and Testing

  • Self-Review: Before submitting, review your changes thoroughly to catch any potential issues.

  • Testing: Test your changes locally to ensure they work as expected.

  • Code Review: Be open to feedback during the review process and be prepared to address any concerns or suggestions raised by reviewers.

Additional Notes

  • Be Patient: Allow time for reviewers to assess your changes and provide feedback. It may take some time, especially for larger or more complex changes.

  • Be Respectful: Maintain a respectful and constructive attitude during discussions and interactions with reviewers and other contributors.

Thank you for your contribution!