Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Added pull_request_template.md #299

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Added pull_request_template.md #299

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
34 changes: 34 additions & 0 deletions .github/pull_request_template.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,34 @@
# Description

Please include a summary of changes, motivation and context for this PR.

Fixes # (issue)

## Type of change

Please tick all options which are relevant.

- [ ] Bug fix
- [ ] New feature
- [ ] Requires documentation updates

# Testing

Please describe the test(s) that you added and ran to verify your changes.

## Test(s) description

**Test Configuration**:

* OS:

# Checklist:

- [ ] I have added tests that prove my fix is effective and/or that my feature works
- [ ] New and existing unit tests pass locally with my changes
- [ ] I have used understandable variable names
- [ ] I have squashed my commits into a single commit ready for review
- [ ] I have run `git-clang-format HEAD~` on my changes
- [ ] I have made corresponding changes to the documentation
- [ ] I have performed a self-review of my own code
- [ ] I have commented my code, particularly in hard-to-understand areas
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Can we collapse these bullets into on that says something similar to “I have read the contribution guide recently” and move these there?

Copy link
Collaborator

@aaronj0 aaronj0 May 29, 2024 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

and maybe provide a guide to open the PR using labels in the name like:

[ci/Interpreter/docs/tests...] title

Fixes # (issue)

  • Tested locally

Test configuration:

should be enough in the PR to make it easy to review

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yeah.

Copy link
Collaborator Author

@mcbarton mcbarton May 31, 2024 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Can we collapse these bullets into on that says something similar to “I have read the contribution guide recently” and move these there?

@vgvassilev @maximusron Do we have a contributors guide somewhere already, and I just can't find it, or do I need to make one?

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think we need to make one. Look at the one in Clad.

Loading