Skip to content

chore: update readme nits#21

Merged
k1LoW merged 1 commit intomainfrom
chore/2025-09-10-readme
Sep 10, 2025
Merged

chore: update readme nits#21
k1LoW merged 1 commit intomainfrom
chore/2025-09-10-readme

Conversation

@jackchuka
Copy link
Copy Markdown
Member

This pull request updates the README.md to improve clarity, add helpful links, and provide more detailed documentation for metrics, lint rules, and contribution guidelines. The changes are primarily focused on enhancing the documentation for users and contributors.

Documentation improvements:

  • Added a link to the Tailor Platform in the project description for better context.
  • Expanded explanations for pipeline, TailorDB, and StateFlow metrics, including clearer descriptions and formatting improvements for formulas.
  • Added more detailed documentation for lint rules, including deprecated feature detection for pipelines, TailorDB, and StateFlow, and configuration options for each rule. [1] [2] [3]
  • Improved the license section to link to the MIT License and added a new contributing section with a reference to CONTRIBUTING.md.

Formatting and output clarity:

  • Enhanced output format example and added coverage breakdown details for the patterner coverage command.
  • Clarified acceptable warning configuration in the lint section for better usability.

@github-actions
Copy link
Copy Markdown
Contributor

Code Metrics Report

Coverage Code to Test Ratio
32.5% 1:1.7

Reported by octocov

@jackchuka jackchuka marked this pull request as ready for review September 10, 2025 03:02
@jackchuka jackchuka requested a review from a team as a code owner September 10, 2025 03:02
Copy link
Copy Markdown
Contributor

@k1LoW k1LoW left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thank you!!

@k1LoW k1LoW merged commit 6c0c04b into main Sep 10, 2025
1 check passed
@k1LoW k1LoW deleted the chore/2025-09-10-readme branch September 10, 2025 04:02
@github-actions github-actions Bot mentioned this pull request Sep 10, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants