Skip to content

Latest commit

 

History

History
80 lines (56 loc) · 3.76 KB

CONTRIBUTING.md

File metadata and controls

80 lines (56 loc) · 3.76 KB
Raw

🌱 Contributing

First, we would like to thank you for your time and efforts on this project, we appreciate it.

Important

At this time, we prioritize bug fixes and code quality improvements over new features. Please refrain from submitting large changes to add new features, as they might not be merged, and exceptions may made. We encourage you to create an issue or reach out beforehand, explaining your proposed changes and their rationale for a higher chance of acceptance. Thank you!

Note

The package version in pubspec.yaml should not be modified; this will be handled by a maintainer or CI. Add updates to Unreleased in CHANGELOG.md following Keep a Changelog format.

📋 Development Prerequisites

🧪 Test your changes

Make sure you have the Requirement installed and configured correctly

To test your changes:

  1. Go to the Example project in main.dart and run the project either by using your IDE or flutter run
  2. Make sure to read the Development Notes if you made certain changes or Translations Page if you made changes to the translations of the package

Guidelines 📝

  1. Code Style and Formatting:

    Adhere to the Dart Coding Conventions (https://dart.dev/effective-dart). Use consistent naming conventions for variables, functions, classes, etc. Follow a consistent code formatting style throughout the project.

    We use Dart lints to make the process easier.

  2. Documentation:

    Document public APIs using Dart comments (https://dart.dev/effective-dart/documentation). Provide comprehensive documentation for any complex algorithms, data structures, or significant functionality. Write clear and concise commit messages and pull request descriptions.

  3. Performance:

    Write efficient code and avoid unnecessary overhead. Profile the application for performance bottlenecks and optimize critical sections if needed.

  4. Bundle size:

    Try to make the package size as less as possible but as much as needed

  5. Code Review:

    Encourage code reviews for all changes to maintain code quality and catch potential issues early. Use pull requests and code reviews to discuss proposed changes and improvements.

  6. Versioning and Releases:

    Follow semantic versioning for releases (https://semver.org/). Clearly document release notes and changes for each version.

    For now, we might introduce breaking changes in a non-major version but will always provide a migration guide in each release info.

  7. Consistency:

    Adhere to a consistent coding style throughout the project for improvement readability and maintainability

  8. Meaningful Names:

    Use descriptive variable, class, and function names that clearly convey their purpose.

  9. Testing:

    Try to write tests (Widget or Unit tests or other types or tests) when possible

📝 Development Notes

  • When updating the translations, refer to the translation page.
  • Package versioning is automated, PRs need to update CHANGELOG.md to add the changes in the Unreleased per Keep a Changelog format.