Proposal : Add a Github PR template

Open Beginner friendly
#2,935 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty
1/5
Estimated time
Under an hour
Newbie friendliness
82/100
Issue type
Documentation
Clarity
Clearly specified
Activity status
Quiet
Tech stack
github
Domain
documentation

Research direction

Create the pull request template at .github/PULL_REQUEST_TEMPLATE.md, using the linked GitHub documentation as the starting reference. Include the proposed Summary, Changes, Tests, Results, and Issue sections; the work is done when the template is present in the MaterialX repository and provides these prompts for new pull requests.

Written by the indexing model from the issue text.

Description

Proposal

Add a Github PR template as part of the MaterialX repo.

  • The default location seems to be: .github/PULL_REQUEST_TEMPLATE.md
  • See docs
Possible properties / content:
## Summary
- What this is about

## Changes
- What was changed

## Tests
- If a fix / addition: specify testing done.

## Results
- Test or other results.

## Issue
update #<issue_number> | fixes #<issue number>
Dominant language
C++
Stars
2.3k
Forks
464
Avg merge
4d 13h
Merged PRs (30d)
13

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from AcademySoftwareFoundation/MaterialX

All issues in AcademySoftwareFoundation/MaterialX

Similar issues

More C++ issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.