Skip to content

Update CONTRIBUTING.md#16

Open
pathankhansalman wants to merge 1 commit into
safal207:mainfrom
pathankhansalman:main
Open

Update CONTRIBUTING.md#16
pathankhansalman wants to merge 1 commit into
safal207:mainfrom
pathankhansalman:main

Conversation

@pathankhansalman

Copy link
Copy Markdown

Summary

One or two sentences. What changes and why.

Spec impact

  • No change to docs/SPEC.md.
  • Editorial change to docs/SPEC.md (no behavioral change).
  • Normative change to docs/SPEC.md. List affected sections below.

If this is a normative change, describe:

  • What invariant or field is added, removed, or changed.
  • Whether previously valid records may now be rejected, or vice versa.
  • The corresponding CHANGELOG.md entry.

Validation and testing

  • schema/drp.schema.json updated if the machine-checkable shape changed.
  • tools/drp_validator.py updated if a new invariant was introduced.
  • Positive fixture(s) added under fixtures/valid/.
  • Negative fixture(s) added under fixtures/invalid/.
  • Tests added or updated under tests/.
  • python3 -m pytest tests/ passes locally.

Breaking change?

  • No. Strictly additive or editorial.
  • Yes. Explain why it is necessary and how consumers migrate.

Checklist

  • Branch is up to date with main.
  • CHANGELOG.md updated under [Unreleased].
  • VERSION updated if this PR cuts a release.
  • No new runtime dependencies added to the reference validator.

Copy link
Copy Markdown
Owner

Thank you for opening this PR — this is a very welcome contribution direction for DRP.

Your PR adds a contributor onboarding section with good-first-issue ideas and beginner-friendly contribution paths. Since this PR was opened, a similar contributor path has already been merged into CONTRIBUTING.md, so merging this PR as-is would duplicate part of the current document.

I do not want to lose the value of your contribution, though. I looked at your public GitHub profile and your background looks especially relevant for a more research-oriented task around evaluation and scoring.

I created a follow-up issue that may be a better fit:

This would help DRP move beyond simple pass/fail validation toward a clearer research framework for evaluating decision-record auditability. A first PR can be documentation-only, with a possible script implementation later.

If you are interested, I would be very happy to review a PR for #21.

Thanks again for being one of the first external contributors to DRP — that matters a lot.

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