From ae85ca18fc9bf210b72ac64beee45d374777c0c6 Mon Sep 17 00:00:00 2001 From: Axel Kohlmeyer Date: Thu, 7 Feb 2019 15:53:46 +0100 Subject: [PATCH] provide multiple and more specific pull request templates --- .github/PULL_REQUEST_TEMPLATE.md | 29 ---------- .github/PULL_REQUEST_TEMPLATE/bug_fix.md | 42 ++++++++++++++ .../maintenance_refactoring.md | 35 ++++++++++++ .github/PULL_REQUEST_TEMPLATE/new_feature.md | 56 +++++++++++++++++++ .../update_enhancement.md | 42 ++++++++++++++ 5 files changed, 175 insertions(+), 29 deletions(-) delete mode 100644 .github/PULL_REQUEST_TEMPLATE.md create mode 100644 .github/PULL_REQUEST_TEMPLATE/bug_fix.md create mode 100644 .github/PULL_REQUEST_TEMPLATE/maintenance_refactoring.md create mode 100644 .github/PULL_REQUEST_TEMPLATE/new_feature.md create mode 100644 .github/PULL_REQUEST_TEMPLATE/update_enhancement.md diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md deleted file mode 100644 index 77c81ea69d..0000000000 --- a/.github/PULL_REQUEST_TEMPLATE.md +++ /dev/null @@ -1,29 +0,0 @@ -## Purpose - -_Briefly describe the new feature(s), enhancement(s), or bugfix(es) included in this pull request. If this addresses an open GitHub Issue, mention the issue number, e.g. with `fixes #221` or `closes #135`, so that issue will be automatically closed when the pull request is merged_ - -## Author(s) - -_Please state name and affiliation of the author or authors that should be credited with the changes in this pull request_ - -## Backward Compatibility - -_Please state whether any changes in the pull request break backward compatibility for inputs, and - if yes - explain what has been changed and why_ - -## Implementation Notes - -_Provide any relevant details about how the changes are implemented, how correctness was verified, how other features - if any - in LAMMPS are affected_ - -## Post Submission Checklist - -_Please check the fields below as they are completed_ -- [ ] The feature or features in this pull request is complete -- [ ] Suitable new documentation files and/or updates to the existing docs are included -- [ ] One or more example input decks are included -- [ ] The source code follows the LAMMPS formatting guidelines - -## Further Information, Files, and Links - -_Put any additional information here, attach relevant text or image files, and URLs to external sites (e.g. DOIs or webpages)_ - - diff --git a/.github/PULL_REQUEST_TEMPLATE/bug_fix.md b/.github/PULL_REQUEST_TEMPLATE/bug_fix.md new file mode 100644 index 0000000000..cea04c6873 --- /dev/null +++ b/.github/PULL_REQUEST_TEMPLATE/bug_fix.md @@ -0,0 +1,42 @@ +--- +name: Bug fix +about: Submit a pull request that fixes one or more bugs +title: "[BUGFIX] _Replace With Suitable Title_" +labels: bugfix +assignees: '' + +--- + +**Summary** + +_Briefly describe the bug or bugs, that are eliminated by this pull request._ + +**Related Issue(s)** + +_If this request addresses or is related to an existing (open) GitHub issue, e.g. a bug report, mention the issue number number here following a pound sign (aka hashmark), e.g.`#222`._ + +**Author(s)** + +_Please state name and affiliation of the author or authors that should be credited with the changes in this pull request_ + +**Licensing** + +By submitting this pull request I implicitly accept, that my submission is subject to the same licensing terms as the files that are modified. + +**Backward Compatibility** + +_Please state whether any changes in the pull request break backward compatibility for inputs, and - if yes - explain what has been changed and why_ + +**Detailed Description** + +_Provide any relevant details about how the fixed bug can be reproduced, how the changes are implemented, how correctness was verified, how other features - if any - in LAMMPS are affected_ + +## Post Submission Checklist + +_Please check the fields below as they are completed *after* the pull request is submitted_ +- [ ] The code in this pull request is complete +- [ ] The source code follows the LAMMPS formatting guidelines + +## Further Information, Files, and Links + +_Put any additional information here, attach relevant text or image files, and URLs to external sites (e.g. to download input decks for testing)_ diff --git a/.github/PULL_REQUEST_TEMPLATE/maintenance_refactoring.md b/.github/PULL_REQUEST_TEMPLATE/maintenance_refactoring.md new file mode 100644 index 0000000000..b3599cb36d --- /dev/null +++ b/.github/PULL_REQUEST_TEMPLATE/maintenance_refactoring.md @@ -0,0 +1,35 @@ +--- +name: Maintenance or Refactoring +about: Submit a pull request that does code refactoring or other maintenance changes +title: "[MAINTENANCE] _Replace With Suitable Title_" +labels: maintenance +assignees: '' + +--- + +**Summary** + +_Briefly describe the included changes._ + +**Related Issue(s)** + +_If this request addresses or is related to an existing (open) GitHub issue, e.g. a bug report, mention the issue number number here following a pound sign (aka hashmark), e.g.`#222`. + +**Author(s)** + +_Please state name and affiliation of the author or authors that should be credited with the changes in this pull request_ + +**Licensing** + +By submitting this pull request I implicitly accept, that my submission is subject to the same licensing terms as the files that are modified. + +**Detailed Description** + +_Provide any relevant details about the included changes._ + +## Post Submission Checklist + +_Please check the fields below as they are completed *after* the pull request is submitted_ +- [ ] The pull request is complete +- [ ] The source code follows the LAMMPS formatting guidelines + diff --git a/.github/PULL_REQUEST_TEMPLATE/new_feature.md b/.github/PULL_REQUEST_TEMPLATE/new_feature.md new file mode 100644 index 0000000000..e9d16a0fc7 --- /dev/null +++ b/.github/PULL_REQUEST_TEMPLATE/new_feature.md @@ -0,0 +1,56 @@ +--- +name: New Feature +about: Submit a pull request that adds new Features (complete files) to LAMMPS +title: "[New Feature] _Replace With Suitable Title_" +labels: enhancement +assignees: '' + +--- + +**Summary** + +_Briefly describe the new feature(s) included in this pull request._ + +**Related Issues** + +_If this addresses an existing (open) GitHub issue, e.g. a feature request, mention the issue number here following a pound sign (aka hashmark), e.g. `#331`._ + +**Author(s)** + +_Please state name and affiliation of the author or authors that should be credited with the features added in this pull request. Please provide a suitable "long-lived" e-mail address (e.g. from gmail, yahoo, outlook, etc.) for the *corresponding* author, i.e. the person the LAMMPS developers can contact directly with questions and requests related to maintenance and support of this code. now and in the future_ + +**Licensing** + +_Please add *yes* or *no* to the following two statements (please contact @lammps/core if you have questions about this)_ + +My contribution may be licensed as GPL v2 (default LAMMPS license): +My contribution may be licensed as LGPL (for use as a library with proprietary software): + +**Backward Compatibility** + +_Please state if any of the changes in this pull request will affect backward compatibility for inputs, and - if yes - explain what has been changed and why_ + +**Implementation Notes** + +_Provide any relevant details about how the new features are implemented, how correctness was verified, what platforms (OS, compiler, MPI, hardware, number of processors, accelerator(s)) it was tested on_ + +## Post Submission Checklist + +_Please check the fields below as they are completed *after* the pull request has been submitted_ + +- [ ] The feature or features in this pull request is complete +- [ ] Licensing information is complete +- [ ] Corresponding author information is complete +- [ ] The source code follows the LAMMPS formatting guidelines +- [ ] Suitable new documentation files and/or updates to the existing docs are included +- [ ] The added/updated documentation is integrated and tested with the documentation build system +- [ ] The feature has been verified to work with the conventional build system +- [ ] The feature has been verified to work with the CMake based build system +- [ ] A package specific README file has been included or updated +- [ ] One or more example input decks are included + +## Further Information, Files, and Links + +_Put any additional information here, attach relevant text or image files, and URLs to external sites (e.g. DOIs or webpages)_ + + diff --git a/.github/PULL_REQUEST_TEMPLATE/update_enhancement.md b/.github/PULL_REQUEST_TEMPLATE/update_enhancement.md new file mode 100644 index 0000000000..52ef91e6c1 --- /dev/null +++ b/.github/PULL_REQUEST_TEMPLATE/update_enhancement.md @@ -0,0 +1,42 @@ +--- +name: Update or Enhancement +about: Submit a pull request that provides update or enhancements for a package or feature in LAMMPS +title: "[UPDATE] _Replace With Suitable Title_" +labels: enhancement +assignees: '' + +--- + +**Summary** + +_Briefly describe what kind of updates or enhancements for a package or feature are included. If you are not the original author of the package or feature, please mention, whether your contribution was created independently or in collaboration/cooperation with the original author._ + +**Author(s)** + +_Please state name and affiliation of the author or authors that should be credited with the changes in this pull request_ + +**Licensing** + +By submitting this pull request I implicitly accept, that my submission is subject to the same licensing terms as the original package or feature(s) that are updated or amended by this pull request. + +**Backward Compatibility** + +_Please state whether any changes in the pull request break backward compatibility for inputs, and - if yes - explain what has been changed and why_ + +**Implementation Notes** + +_Provide any relevant details about how the changes are implemented, how correctness was verified, how other features - if any - in LAMMPS are affected_ + +**Post Submission Checklist** + +_Please check the fields below as they are completed_ +- [ ] The feature or features in this pull request is complete +- [ ] Suitable updates to the existing docs are included +- [ ] One or more example input decks are included +- [ ] The source code follows the LAMMPS formatting guidelines + +**Further Information, Files, and Links** + +_Put any additional information here, attach relevant text or image files, and URLs to external sites (e.g. DOIs or webpages)_ + +