From ba8fab1340c828b02acb949ab4d125011bb3ea9f Mon Sep 17 00:00:00 2001 From: Micah Gale Date: Thu, 11 Jan 2024 14:26:38 -0600 Subject: [PATCH 1/4] Update issue templates --- .github/ISSUE_TEMPLATE/bug_report.md | 37 +++++++++++++++++++++++ .github/ISSUE_TEMPLATE/feature_request.md | 23 ++++++++++++++ 2 files changed, 60 insertions(+) create mode 100644 .github/ISSUE_TEMPLATE/bug_report.md create mode 100644 .github/ISSUE_TEMPLATE/feature_request.md diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md new file mode 100644 index 00000000..46c1f24f --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug_report.md @@ -0,0 +1,37 @@ +--- +name: Bug report +about: Create a report to help us improve +title: '' +labels: bug +assignees: '' + +--- + +**Reminders** +1. This is not a place to debug your MCNP models +1. MCNP is export controlled and only its 6.2 and 6.3 user manuals are public. Don't include any information about MCNP which is not in those manuals. +1. Your model may be export controlled, or proprietary. Please change specific numbers (e.g., dimensions, material compositions, etc.) in your minimum working examples. + +**Describe the bug** +A clear and concise description of what the bug is. + +**To Reproduce** +Steps to reproduce the behavior: +1. Go to '...' +2. Click on '....' +3. Scroll down to '....' +4. See error + +**Expected behavior** +A clear and concise description of what you expected to happen. + +**Screenshots** +If applicable, add screenshots to help explain your problem. + +**Desktop (please complete the following information):** + - OS: [e.g. iOS] + - Version [e.g. 0.2.5] + + +**Additional context** +Add any other context about the problem here. diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md new file mode 100644 index 00000000..a7683470 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/feature_request.md @@ -0,0 +1,23 @@ +--- +name: Feature request +about: Suggest an idea for this project +title: '' +labels: '' +assignees: '' + +--- + +**Is your feature request related to a problem? Please describe.** +A clear and concise description of what the problem is. Ex. I'm always frustrated when [...] + +**Describe the solution you'd like** +A clear and concise description of what you want to happen. + +**Describe alternatives you've considered** +A clear and concise description of any alternative solutions or features you've considered. + +**Additional context** +Add any other context or screenshots about the feature request here. + +** Reminder ** +Only the MCNP 6.2 and 6.3 user manuals are public. If this discusses a feature of MCNP you could only know by running MCNP please do not include it. From d0b0428aaef85e38816d84217cacae7154e5854b Mon Sep 17 00:00:00 2001 From: "Micah D. Gale" Date: Thu, 11 Jan 2024 20:33:13 -0600 Subject: [PATCH 2/4] updated link to issue in dev. --- doc/source/developing.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/doc/source/developing.rst b/doc/source/developing.rst index 4bf70d34..c6ec53a2 100644 --- a/doc/source/developing.rst +++ b/doc/source/developing.rst @@ -322,7 +322,7 @@ How to __str__ vs __repr__ """""""""""""""""""""""""" All objects must implement ``__str__`` (called by ``str()``), and ``__repr__`` (called by ``repr()``). -See `this issue `_ for a more detailed discussion. +See `this issue `_ for a more detailed discussion. In general ``__str__`` should return a one line string with enough information to uniquely identify the object. For numbered objects this should include their number, and a few high level details. For ``__repr__`` this should include debugging information. From 33dd0d28289e9420e4465247290140e7af126720 Mon Sep 17 00:00:00 2001 From: "Micah D. Gale" Date: Mon, 15 Jan 2024 08:31:03 -0600 Subject: [PATCH 3/4] Updated hyperlink for MCNP 6.2 manual --- doc/source/index.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/doc/source/index.rst b/doc/source/index.rst index 4f7d4e9c..be171a76 100644 --- a/doc/source/index.rst +++ b/doc/source/index.rst @@ -22,7 +22,7 @@ See Also ======== * `MontePy github Repository `_ -* `MCNP 6.2 User Manual `_ +* `MCNP 6.2 User Manual `_ * `MCNP 6.3 User Manual `_ Indices and tables From b6ef7de77635b6da2f84fc02a7895add967274ef Mon Sep 17 00:00:00 2001 From: Micah Gale Date: Mon, 15 Jan 2024 13:09:17 -0600 Subject: [PATCH 4/4] Added feature request tag to issue template --- .github/ISSUE_TEMPLATE/feature_request.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md index a7683470..32076a73 100644 --- a/.github/ISSUE_TEMPLATE/feature_request.md +++ b/.github/ISSUE_TEMPLATE/feature_request.md @@ -2,7 +2,7 @@ name: Feature request about: Suggest an idea for this project title: '' -labels: '' +labels: 'feature request' assignees: '' --- @@ -19,5 +19,5 @@ A clear and concise description of any alternative solutions or features you've **Additional context** Add any other context or screenshots about the feature request here. -** Reminder ** +**Reminder** Only the MCNP 6.2 and 6.3 user manuals are public. If this discusses a feature of MCNP you could only know by running MCNP please do not include it.