VeryGoodOpenSource / VeryGoodOpenSource/very_good_analysis
docs: Package Update Policy - Very Good Analysis Rules
Nobody has claimed this yet.
- Dominant language
- Dart
- Stars
- 474
- Forks
- 50
- Avg merge
- 2h 4m
- Merged PRs (30d)
- 3
Description
Overview
Define and document the package update policy for lint rules managed by very_good_analysis.
IMPORTANT: This issue will be addressed by the project's code owners. If you are an external contributor, please leave this to the maintainers.
Scope
This policy should cover:
- How often the lint rules package and its dependencies are updated
- Who is responsible for initiating and reviewing updates
- How new Dart/Flutter lint rules are evaluated before being added
- How breaking lint rule changes are communicated and rolled out
- Whether updates are automated or manual
Tasks
- Document the update policy for
very_good_analysisdependencies - Define the process for evaluating and adopting new lint rules
- Establish a communication plan for breaking lint changes
- Add policy to
CONTRIBUTING.mdor a dedicatedPOLICY.md
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start by reviewing the update-policy scope and tasks in the issue, then inspect CONTRIBUTING.md and determine whether a dedicated POLICY.md is more appropriate. The work is done when the dependency update schedule, ownership, lint-rule evaluation process, breaking-change communication, and automation approach are documented for very_good_analysis.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- dart, flutter
- Domain
- documentation, tooling
- Issue type
- Documentation
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Quiet
- Clarity
- Mostly clear
- Newbie friendliness
- 20/100