vercel-labs / vercel-labs/konsistent

Use “convention” instead of “rule” throughout documentation

Open Beginner friendly
#67 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

bug
Dominant language
TypeScript
Stars
176
Forks
6
Avg merge
20h 26m
Merged PRs (30d)
11

Description

The documentation alternates between “rule” and “convention” for the same Konsistent concept, while predicates are the actual individual checks inside a convention. This makes the policy hierarchy harder to understand and should use “convention” consistently.

Relevant files:

  • packages/konsistent/README.md
  • docs/README.md
  • docs/reference/configuration.md
  • docs/reference/conditional-rules.md
  • docs/guides/getting-started.md

Replace “rule” with “convention” wherever the full scoped policy is meant, including headings, filenames, links, examples, and internal identifiers that encode the documentation term. Keep “predicate” for an individual assertion.

Backward compatibility: documentation and internal terminology can be renamed or removed without compatibility shims. No konsistent.json schema change is expected; if one becomes necessary, retain the old name and behavior as deprecated and emit a non-failing CLI warning when it is used.

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by reviewing packages/konsistent/README.md, docs/README.md, docs/reference/configuration.md, docs/reference/conditional-rules.md, and docs/guides/getting-started.md, then search those files for the scoped use of “rule.” Done means the documentation consistently uses “convention” for the full policy, preserves “predicate” for individual assertions, and updates affected headings, links, examples, filenames, and internal identifiers without changing the konsistent.json schema.

Written by the indexing model from the issue text.

Assessment

Tech stack
typescript
Domain
documentation
Issue type
Documentation
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Quiet
Clarity
Mostly clear
Newbie friendliness
75/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.