Skip to content

Add SECURITY.md and CONTRIBUTING.md #36

Description

@andremun

Summary

Verified: neither file exists in this repo. .github/ISSUE_TEMPLATE/ has bug_report.md and
feature_request.md, but there's no vulnerability-reporting policy and no contributor guide —
despite this repo having had real multi-contributor history (the Python port's own
pyproject.toml, forked from this toolkit's methodology, lists nine historical student authors
from the same research group's coursework project).

Proposed change

  • SECURITY.md: how to report a vulnerability (contact method, expected response time if
    any). Short — this is research software, not a security-critical service, but a documented
    policy costs little and is standard practice, particularly given this toolkit's stated
    aspiration (shared with the Python port) to eventually power MATILDA's web backend.
  • CONTRIBUTING.md: dev environment setup (MATLAB version + required toolboxes, already
    listed in README.md — mostly a pointer, not a rewrite), how to run test_integration.m and
    example.m before submitting a PR, and basic code-style expectations (matching what's already
    implicit in the codebase's existing conventions).

Motivation

Standard OSS hygiene. Both files are small, additive, and touch no code — pure documentation.

Acceptance criteria

  • SECURITY.md added at repo root
  • CONTRIBUTING.md added at repo root, referencing existing README.md setup instructions
    rather than duplicating them
  • Both linked from README.md if not automatically surfaced by GitHub's repo UI

Part of the v0.9.1 milestone. Source: general best-practices pass across both the MATLAB and Python repos. Independent of the other issues in this batch and of batches 1/2 — can happen any time.

Metadata

Metadata

Assignees

No one assigned

    Projects

    No projects

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions