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

Update PR template after relicensing #4860

Open
wants to merge 2 commits into
base: develop
Choose a base branch
from
Open

Update PR template after relicensing #4860

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
73c6c06
update
RMeli Dec 22, 2024
d5fef31
improvements
RMeli Jan 8, 2025
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
31 changes: 22 additions & 9 deletions .github/PULL_REQUEST_TEMPLATE.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,15 +1,28 @@
<!--
Insert issue number that this PR fixes (if any) just after 'Fixes #'.
If this PR does not fix an existing issue, consider opening one or remove 'Fixes #' from the PR description.
-->
Fixes #

Changes made in this Pull Request:
-
<!-- Describe the changes that this PR makes. If applicable, use the following bullet list. -->
-


PR Checklist
------------
- [ ] Tests?
- [ ] Docs?
- [ ] CHANGELOG updated?
## PR Checklist
<!-- Please use the following checklist to ensure the PR is ready to be reviewed/merged. -->
- [ ] Issue raised/referenced?
RMeli marked this conversation as resolved.
Show resolved Hide resolved
- [ ] Tests updated/added?
- [ ] Documentation updated/added?
- [ ] `package/CHANGELOG` file updated?
- [ ] Is your name in `package/AUTHORS`? (If it is not, add it!)

## Developers Certificate of Origin
<!--
CHECKING THE FOLLOWING BOX (BY ADDING 'x' INSIDE THE BRACKETS `[x]`) IS MANDATORY FOR ALL PRs.
Copy link
Member

Choose a reason for hiding this comment

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

So as per my last comment, I'd be perfectly happy with this being there without a tick box - especially if it's going to be a pain for others.

That is to say, if you wanted to just make this an implicit agreement - i.e. a footer that says "by summiting this code you agree to.." then that'd have the same effect. At the end of the day the good actors will act well and the bad actors will act badly.

Copy link
Member Author

Choose a reason for hiding this comment

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

Happy to go with a non-ticking implicit agreement. The comment can then say to not delete/modify the following lines one wants the PR to be merged?

-->

In order for this PR to be merged you **must certify that you are able to submit your code to be included in MDAnalysis**. Read the links and then check the box if you agree.

Code in MDAnalysis is under [LICENSE](https://github.com/MDAnalysis/mdanalysis/blob/develop/LICENSE).
Copy link
Member

Choose a reason for hiding this comment

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

Suggested change
Code in MDAnalysis is under [LICENSE](https://github.com/MDAnalysis/mdanalysis/blob/develop/LICENSE).
Code in MDAnalysis is licensed under [LGPLv2+](https://github.com/MDAnalysis/mdanalysis/blob/develop/LICENSE).

Or something like that? This isn't a "content" comment, but rather a "that sentence flows weird when I read it", so it could just be me.

Copy link
Member Author

Choose a reason for hiding this comment

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

I think the idea here was to not mention the specific license directly. But maybe it's better to do so. Otherwise I can try to find an alternative phrasing which allows to link to the license file without explicitly mentioning the license.


## Developers certificate of origin
- [ ] I certify that this contribution is covered by the LGPLv2.1+ license as defined in our [LICENSE](https://github.com/MDAnalysis/mdanalysis/blob/develop/LICENSE) and adheres to the [**Developer Certificate of Origin**](https://developercertificate.org/).
Comment on lines -14 to -15
Copy link
Member

Choose a reason for hiding this comment

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

I agree with removing.

@IAlibay , your opinion is also important here – can you please weigh in?

- [ ] I certify that I can legally submit this code contribution as described in the [**Developer Certificate of Origin**](https://developercertificate.org/)
Copy link
Member

Choose a reason for hiding this comment

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

This is very much just a nit pick - "legally" can be a bit jarring, the wording can work without too it if you feel like it.

Copy link
Member Author

Choose a reason for hiding this comment

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

Good point, I'll remove it.

Loading