Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
55 lines (35 loc) · 1.81 KB

CONTRIBUTING.md

File metadata and controls

55 lines (35 loc) · 1.81 KB
Raw

Contributing

Thank you for your interest in improving the RFC 5545 VEVENT Property Dependency Graph.

Types of Contributions

Edge Corrections

If an edge has the wrong target, strength, or direction, open an issue or PR with:

  1. RFC section number justifying the correction
  2. Current edge (what the graph says)
  3. Proposed edge (what it should say)
  4. Test vector -- a minimal VEVENT that demonstrates the difference

Edge corrections are patch-level version bumps.

New Properties or Edge Types

If a property or edge type is missing, include:

  1. RFC section number(s) justifying the addition
  2. Merge safety classification with rationale
  3. Whether it affects existing edges (e.g., adding a new property that depends on DTSTART)
  4. Test vector

New properties are minor-level version bumps.

Bug Reports from the Wild

If you find a calendar bug that traces to a missing or incorrect dependency rule:

  1. Link to the issue (GitHub, GitLab, etc.)
  2. Identify which edge in the graph (or missing from it) is relevant
  3. Classify as [E] expansion, [V] validation, or [M] merge/sync

These are added to the evidence catalog in the companion document.

Process

  1. Open an issue describing the change
  2. If the change is non-trivial, discuss before submitting a PR
  3. PRs must update both YAML and JSON files consistently
  4. Include the RFC section number in commit messages

Style

  • YAML comments explain rationale; the prose document has the full argument
  • JSON _note fields mirror YAML comments for the same property
  • Fields prefixed with _ are non-normative
  • Edge strength must match RFC language: "MUST" → must, "SHOULD" → should

Scope

This graph covers VEVENT only. VTODO and VJOURNAL contributions are welcome but will be separate files (e.g., rfc5545-deps-vtodo.yaml).