Skip to content

Update pull_request_template.md#2130

Merged
willend merged 1 commit intomainfrom
willend-patch-2
Oct 9, 2025
Merged

Update pull_request_template.md#2130
willend merged 1 commit intomainfrom
willend-patch-2

Conversation

@willend
Copy link
Contributor

@willend willend commented Oct 9, 2025

Interchange free-form area and chekclist

PR Checklist for contributing to McStas/McXtrace

For a coherent and useful contribution to McStas/McXtrace, please fill in and follow the checklists:

  • My contribution includes patches to an existing component file

    • I have used the mcdoc utility and rendered a reasonable documentation page for the component (please attach as screenshot in comments!)
    • I have ensured that basic use of the component is OK (e.g. an instrument using it compiles?)
    • I have used the mctest utility to test one or more instruments making use of the component (please attach mcviewtest report as screenshot in comments)
    • I have used the mcrun -c-lint "linter" and followed advice to remove most / all warnings that are raised
  • My contribution includes patches to an existing instrument file

    • I have used the mcdoc utility and rendered a reasonable documentation page for the instrument (please attach as screenshot in comments!)
    • I have used the mctest utility to test the instrument (please attach mcviewtest report as screenshot in comments)
    • I have used the mcrun -c-lint "linter" and followed advice to remove most / all warnings that are raised
  • My contribution includes a new component file

    • I have ensured that naming of parameters are in the style of existing components
    • I have ensured that component parameters are in the usualy units of McStas/McXtrae (SI + neutron/x-ray 'usual' units)
    • I have used the mcdoc utility and rendered a reasonable documentation page for the component (please attach as screenshot in comments!)
    • I have ensured that basic use of the component is OK (e.g. an instrument using it compiles?)
    • I have included a corresponding example instrument and will fill in the new instrument section below
  • My contribution includes a new instrument file

    • I have used the mcdoc utility and rendered a reasonable documentation page for the instrument (please attach as screenshot in comments!)
    • I have ensured that basic use of the instrument is OK (e.g. it compiles?)
    • ... and provided reasonable default parameters in that instrument that produce reasonable output
    • ... and maybe even added a %Example: line to describe expected behaviour
    • I have used the mcrun -c-lint "linter" and followed advice to remove most / all warnings that are raised
  • My work touches the code-generator in mccode/src

    • I have added reasoning and documentation for the change in ./docs/GRAMMAR/ADR-records/
    • I am attaching test output in the comments
  • My work touches / adds to the runtime lib code (.c,.h etc in multiple locations

    • I am have added reasoning and documentation for the change below
    • I am attaching test output in the comments
  • My PR is meant to fix a specific, existing issue

    • I have indicated the issue number here:
    • I have added documentation for the fix and possible side effects
  • My contribution contains something else

    • Explanation follows below

Free-form text area

Please describe what your PR is adding in terms of features or bugfixes:

Order of the form exchanged.

Development OS / boundary conditions

Please describe what OS you developed and tested your additions on, and if any special dependencies are required:

Interchange free-form area and chekclist
@willend willend merged commit 7108980 into main Oct 9, 2025
45 checks passed
@willend willend deleted the willend-patch-2 branch October 21, 2025 11:47
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.

1 participant

Comments