Skip to content
Snippets Groups Projects
Commit fa3c7727 authored by Axel Kohlmeyer's avatar Axel Kohlmeyer
Browse files

contributing guidelines, issue and pull request template are now feature complete

This is still a draft and in need of editing, proofreading and testing for formatting.
parent 374eef2b
No related branches found
No related tags found
No related merge requests found
This diff is collapsed.
...@@ -8,23 +8,24 @@ _Is this a 'Bug Report' or a 'Suggestion for an Enhancement'?_ ...@@ -8,23 +8,24 @@ _Is this a 'Bug Report' or a 'Suggestion for an Enhancement'?_
## Detailed Description (Enhancement Suggestion) ## Detailed Description (Enhancement Suggestion)
_Explain how you would like to see LAMMPS enhanced, what feature you are looking for, provide references to relevant background information, and whether you are willing to implement the enhancement yourself_ _Explain how you would like to see LAMMPS enhanced, what feature(s) you are looking for, provide references to relevant background information, and whether you are willing to implement the enhancement yourself or would like to participate in the implementation_
## LAMMPS Version (Bug Report) ## LAMMPS Version (Bug Report)
_Please specify which LAMMPS version this issue applies to_ _Please specify which LAMMPS version this issue was detected with. If this is not the latest development version, please stop and test that version, too, and report it here if the bug persists_
## Expected Behavior (Bug Report) ## Expected Behavior (Bug Report)
_Describe the expected behavior. Quote from the LAMMPS manual where needed or explain why the expected behavior is meaningful_ _Describe the expected behavior. Quote from the LAMMPS manual where needed or explain why the expected behavior is meaningful, especially when it differs from the manual_
## Actual Behavior (Bug Report) ## Actual Behavior (Bug Report)
_Describe the actual behavior, how it differs from the expected behavior, and how this can be observed_ _Describe the actual behavior, how it differs from the expected behavior, and how this can be observed. Try to be specific and do **not* use vague terms like "doesn't work" or "wrong result". Do not assume that the person reading this has any experience with or knowledge of your specific research._
## Steps to Reproduce (Bug Report) ## Steps to Reproduce (Bug Report)
_Describe the steps required to quickly reproduce the issue. You can attach (small) files to the section below or add URLs where to download an archive with all necessary files. Please try to create as small and as fast to run inputs as possible. The less effort and time it takes to reproduce your issue, the more likely, that somebody will look into it._ _Describe the steps required to quickly reproduce the issue. You can attach (small) files to the section below or add URLs where to download an archive with all necessary files. Please try to create input that are as small as possible and run as fast as possible. NOTE: the less effort and time it takes to reproduce your issue, the more likely, that somebody will look into it._
## Further Information, Files, and Links ## Further Information, Files, and Links
_Put any additional information here, attach relevant text or image files and URLs to external sites, e.g. relevant publications_ _Put any additional information here, attach relevant text or image files and URLs to external sites, e.g. relevant publications_
## Purpose ## Purpose
_Briefly describe the new feature(s) included in this pull request.
If this addresses an open GitHub Issue, mention the issue number, e.g. with `fixes #221`_ _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_
## Implementation Notes ## Implementation Notes
_Provide any relevant details about how the feature is implemented,
how correctness was verified, how other features in LAMMPS are affected_ _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 ## Post Submission Checklist
Please check the fields as they are completed
- [ ] The feature or features in the pull request is complete _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 - [ ] Suitable new documentation files and/or updates to the existing docs are included
- [ ] One or more example input decks are included - [ ] One or more example input decks are included
- [ ] The source code follows the LAMMPS formatting guidelines - [ ] The source code follows the LAMMPS formatting guidelines
## Further Information, Files, and Links ## Further Information, Files, and Links
_Put any additional information here, attach relevant text or image files and URLs to external sites_
_Put any additional information here, attach relevant text or image files, and URLs to external sites (e.g. DOIs or webpages)_
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment