Skip to content

Latest commit

 

History

History
73 lines (49 loc) · 2.6 KB

CONTRIBUTING.md

File metadata and controls

73 lines (49 loc) · 2.6 KB

Contributing Guidelines

Thank you for supporting our open source project! No matter whether you report bugs, develop new functions, revise the documentation or contribute other ideas - every contribution makes a difference.

To ensure that your support is as effective as possible, we ask you to observe the following guidelines.

We look forward to your input and to moving the project forward together!

Creating Good Tickets

Tip

Please look into existing issues before creating filing bug reports or feature requests

Bug Reports

When reporting a bug, please include the following information:

  1. Title: A brief, descriptive title for the bug.
  2. Version: The package version causing the bug.
  3. Flutter Version: The Flutter version used to produce the bug.
  4. Steps to Reproduce: Detailed steps on how to reproduce the bug.
  5. Expected Result: What you expected to happen.
  6. Actual Result: What actually happened. Include relevant information like screenshots or logs.

Feature Requests

When requesting a new feature, please include the following information:

  1. Title: A brief, descriptive title for the feature request.
  2. Request Statement: Describe a text draw style you would love to use in this
  3. package or any other future you think would provide value to others.
  4. Optional: Possible Solution: You can share possible solutions you have in mind.

Tip

Remember, the more information you provide, the easier it is for us to understand and address the issue. Thank you for your contributions! Please refrain from commenting on old, closed tickets. If an old issue seems related but doesn't fully address your problem, it's best to open a new ticket and reference the old one instead.

Development

Setup

Please use the latest Flutter Version. Use the provided example project to test or bug report any existing or new features.

Submitting changes

Before submitting your changes as a pull request, please make sure to format and analyze your code.

Commit Guidelines

Please make sure that your commit messages follow the follwing templates.

Commit Template

The commit message starts with the ISSUE-ID followed by a COMMITTAG:

{ISSUE-ID} [{COMMITTAG}]: {COMMIT MSG}

[ADD] -> New feature/files/code/folders added
[UPDATE] -> Updated a file e.g. from screenshot test
[FIX] -> Fixed a bug/error
[DELETE] -> Delete a files/code/folders
[REFAC] -> Modified or refactored the files/code/folders / changes from PRs

Example
123 [ADD]: new box style