Skip to content

Latest commit

 

History

History
59 lines (40 loc) · 1.96 KB

CONTRIBUTING.md

File metadata and controls

59 lines (40 loc) · 1.96 KB

Contributing to Tagflow

We love your input! We want to make contributing to Tagflow as easy and transparent as possible, whether it's:

  • Reporting a bug
  • Discussing the current state of the code
  • Submitting a fix
  • Proposing new features
  • Becoming a maintainer

We Develop with Github

We use GitHub to host code, to track issues and feature requests, as well as accept pull requests.

We Use Github Flow

Pull requests are the best way to propose changes to the codebase. We actively welcome your pull requests:

  1. Fork the repo and create your branch from main.
  2. If you've added code that should be tested, add tests.
  3. If you've changed APIs, update the documentation.
  4. Ensure the test suite passes.
  5. Make sure your code follows the existing style.
  6. Issue that pull request!

Code Style and Standards

Dart Code Style

  • Follow the Dart Style Guide
  • Use the provided analysis_options.yaml
  • Run dart format before committing
  • Ensure there are no analyzer warnings

HTML Support Standards

When adding support for HTML elements and attributes:

  1. Follow standard HTML specifications
  2. Implement attributes according to their standard behavior
    • Example: table border attribute affects outer border width and adds 1px borders to cells
  3. Document any deviations from standard HTML behavior
  4. Add appropriate test cases

Package Structure

  • Keep core functionality in the tagflow package
  • Place specialized widgets in their respective packages (e.g., tagflow_table)
  • Maintain backward compatibility when possible

License

By contributing, you agree that your contributions will be licensed under its MIT License.

References