Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
62 lines (45 loc) · 2.29 KB

CONTRIBUTING.md

File metadata and controls

62 lines (45 loc) · 2.29 KB
Raw

Contributing to MarrowGlass Orders

This repository is a service-intake portal, not a normal software product repository. There is no application code here to build or run. The contents are issue forms, documentation, and a single intake workflow.

Contributions that improve the intake experience are welcome. Contributions that introduce client work are not — client work belongs in a private repository.

What belongs here

  • Improvements to the issue forms in .github/ISSUE_TEMPLATE/.
  • Improvements to README.md, SECURITY.md, and this file.
  • Changes to the intake workflow in .github/workflows/.
  • Changes to the pull request template.
  • Adjustments to labels, descriptions, and intake wording.

What does not belong here

  • Client source code or assets.
  • Real client names, URLs, credentials, or data.
  • Anything that should be private. If in doubt, keep it out.

Proposing changes

  1. Open an Issue describing what you want to change and why. Small wording fixes can go straight to a pull request.
  2. For workflow changes, say which form or step is affected and what the new behavior should be.
  3. Keep public-facing wording precise and professional. Avoid marketing claims.

Validating before a pull request

Check your changes locally before opening a pull request:

# Validate YAML for issue forms and the workflow
python3 -m yaml.tool .github/ISSUE_TEMPLATE/project-request.yml
python3 -m yaml.tool .github/ISSUE_TEMPLATE/consultation.yml
python3 -m yaml.tool .github/ISSUE_TEMPLATE/config.yml
python3 -m yaml.tool .github/workflows/intake-validation.yml

# If actionlint is installed, check the workflow
actionlint .github/workflows/intake-validation.yml

# If a Markdown link checker is installed, check the README
npx --yes markdown-link-check README.md

Issue forms are GitHub Issue Forms YAML. Confirm that:

  • name, description, labels, and body are present.
  • Each form item has a valid type (markdown, textarea, input, dropdown, checkboxes).
  • Required fields use validations: required: true.
  • Dropdowns and checkboxes use the options list correctly.

Pull requests

When you open a pull request, fill in the template. In particular, confirm whether public-facing wording changed and whether you checked the diff for anything that should not be public.