Skip to content

[ENH] Minor improvements to PR template #2636

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

Merged
merged 2 commits into from
Jul 19, 2018
Merged

[ENH] Minor improvements to PR template #2636

merged 2 commits into from
Jul 19, 2018

Conversation

oesteban
Copy link
Contributor

@oesteban oesteban commented Jul 13, 2018

Summary

After our experience with https://github.com/poldracklab/fmriprep/blob/master/docs/pull_request_template.md, I apply here @effigies' suggestion of using HTML comments, and add a checkbox for the license.

Please, have a look into FMRIPREP's template to decide whether we want to import any more ideas into nipype.

List of changes proposed in this PR (pull-request)

  • Use HTML comments in the PR template to avoid asking contributors to remove text.

Acknowledgment

  • (Mandatory) I acknowledge that this contribution will be available under the Apache 2 license.

<!--

Pull-request guidelines
-----------------------

1. If you would like to list yourself as a Nipype contributor and your name is not mentioned please modify .zenodo.json file.
2. By submitting this request you acknowledge that your contributions are available under the Apache 2 license.
3. Use a descriptive prefix for your PR: ENH (enhancement), FIX, TST, DOC, STY, REF (refactor), WIP (Work in progress)
4. The person who accepts/merges your PR will include an update to the CHANGES file: prefix: description (URL of pull request)
5. Run `make check-before-commit` before submitting the PR.

-->
## Summary
<!-- Please reference any related issue and use fixes/close to automatically
close them, if pertinent -->
After our experience with https://github.com/poldracklab/fmriprep/blob/master/docs/pull_request_template.md, I apply here @effigies suggestion of using HTML comments, and add a checkbox for the license.

Please, have a look into FMRIPREP's template to decide whether we want to import any more ideas into nipype.

## List of changes proposed in this PR (pull-request)
<!-- We suggest using bullets (indicated by * or -) and filled checkboxes [x] here -->
- [x] Use HTML comments in the PR template to avoid asking contributors to remove text.

## Acknowledgment

- [x] \(Mandatory\) I acknowledge that this contribution will be available under the Apache 2 license.
@oesteban oesteban requested a review from satra July 13, 2018 15:18
@codecov-io
Copy link

codecov-io commented Jul 13, 2018

Codecov Report

Merging #2636 into master will not change coverage.
The diff coverage is n/a.

Impacted file tree graph

@@          Coverage Diff           @@
##           master   #2636   +/-   ##
======================================
  Coverage    67.6%   67.6%           
======================================
  Files         340     340           
  Lines       43003   43003           
  Branches     5321    5321           
======================================
  Hits        29071   29071           
+ Misses      13233   13225    -8     
- Partials      699     707    +8
Flag Coverage Δ
#smoketests 50.52% <ø> (ø) ⬆️
#unittests 65.05% <ø> (ø) ⬆️
Impacted Files Coverage Δ
nipype/interfaces/freesurfer/preprocess.py 66.27% <0%> (ø) ⬆️
nipype/interfaces/io.py 54.68% <0%> (ø) ⬆️
nipype/interfaces/nipy/preprocess.py 45.79% <0%> (ø) ⬆️
nipype/interfaces/dynamic_slicer.py 17.47% <0%> (ø) ⬆️

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 7ea4f1b...f1859d4. Read the comment docs.

Copy link
Member

@mgxd mgxd left a comment

Choose a reason for hiding this comment

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

lgtm

<!--

Pull-request guidelines
-----------------------

1. If you would like to list yourself as a Nipype contributor and your name is not mentioned please modify .zenodo.json file.
2. By submitting this request you acknowledge that your contributions are available under the Apache 2 license.
3. Use a descriptive prefix for your PR: ENH (enhancement), FIX, TST, DOC, STY, REF (refactor), WIP (Work in progress)
4. The person who accepts/merges your PR will include an update to the CHANGES file: prefix: description (URL of pull request)
Copy link
Member

Choose a reason for hiding this comment

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

We can remove 4) as this is now scripted

@satra satra merged commit ad506f2 into master Jul 19, 2018
@effigies effigies deleted the oesteban-patch-1 branch July 20, 2018 01:33
@effigies effigies added this to the 1.1.1 milestone Jul 20, 2018
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.

5 participants