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.

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

Added pull_request_template.md #299

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

Conversation

mcbarton
Copy link
Collaborator

This PR adds a basic pull request template to the repo. @vgvassilev @maximusron This PR is ready for review.

.github/pull_request_template.md Outdated Show resolved Hide resolved
- [ ] 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
- [ ] My changes generate no new warnings
Copy link
Contributor

Choose a reason for hiding this comment

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

Nice, but do you expect people to follow it :) ?

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

Not sure whether people will follow it, but its good to have as a reminder to those putting in PRs.

.github/pull_request_template.md Outdated Show resolved Hide resolved
mcbarton added a commit to mcbarton/CppInterOp that referenced this pull request May 22, 2024
mcbarton added a commit to mcbarton/CppInterOp that referenced this pull request May 22, 2024
Copy link

codecov bot commented May 22, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 74.57%. Comparing base (5f1d956) to head (f9bcaff).
Report is 2 commits behind head on main.

Additional details and impacted files

Impacted file tree graph

@@           Coverage Diff           @@
##             main     #299   +/-   ##
=======================================
  Coverage   74.57%   74.57%           
=======================================
  Files           8        8           
  Lines        3214     3214           
=======================================
  Hits         2397     2397           
  Misses        817      817           

@mcbarton
Copy link
Collaborator Author

@vgvassilev Is this PR ok to merge?

- [ ] 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

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

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.

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.

3 participants