Skip to content

Commit cd848a0

Browse files
mrmundtmrmundt
committed
Add issue and PR templates
1 parent fa7f74d commit cd848a0

File tree

4 files changed

+118
-0
lines changed

4 files changed

+118
-0
lines changed

‎.github/ISSUE_TEMPLATE/bug_report.md‎

Lines changed: 56 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,56 @@
1+
---
2+
name: "Bug report"
3+
about: Report a bug in Pyomo (command not working as expected, etc.)
4+
labels: "bug"
5+
---
6+
7+
<!-- DO NOT DELETE OR IGNORE THIS TEMPLATE. Failing to adhere to this template and provide the necessary information may lead to your Issue being closed without consideration. -->
8+
9+
## Summary
10+
11+
<!-- Explain, in a clear and concise way, the command you ran and the result you were trying to achieve.
12+
Example: "I ran `pyomo solve` to optimize a model and ..." -->
13+
14+
### Steps to reproduce the issue
15+
16+
<!-- Please include the command run and/or provide an example script that demonstrates the problem. -->
17+
18+
```console
19+
$ command1 [options]
20+
$ command2 [options]
21+
...
22+
```
23+
24+
```
25+
# example.py
26+
import pyomo.environ
27+
...
28+
```
29+
30+
### Error Message
31+
32+
<!-- If Pyomo reported an error, provide the error message. PLEASE INCLUDE THE ENTIRE STACK TRACE. -->
33+
34+
<!-- If it did not report an error but the output appears incorrect, provide the incorrect output. If there was no error message and no output but the result is incorrect, describe how it does not match what you expect. -->
35+
```console
36+
$ # Output message here, including entire stack trace, if available
37+
```
38+
39+
### Information on your system
40+
41+
Pyomo version:
42+
Python version:
43+
Operating system:
44+
How Pyomo was installed (PyPI, conda, source):
45+
Solver (if applicable):
46+
47+
48+
### Additional information
49+
50+
<!-- If you have any additional information, please list it here. -->
51+
52+
53+
<!-- We encourage you to try, as much as possible, to reduce your problem to the minimal example that still reproduces the issue. That would help us a lot in fixing it quickly and effectively!
54+
55+
If you want to ask a question (how to use Pyomo, what it can do, etc.), please refer to our [online documentation](https://github.com/Pyomo/pyomo#getting-help) on ways to get help. -->
56+

‎.github/ISSUE_TEMPLATE/config.yml‎

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
blank_issues_enabled: false
2+
3+
contact_links:
4+
- name: Get help/Ask a question
5+
url: https://github.com/Pyomo/pyomo#getting-help
6+
about: Have a question? Need some help from the community? Refer to our online documentation for ways to get help.

‎.github/ISSUE_TEMPLATE/feature_request.md‎

Lines changed: 30 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,30 @@
1+
---
2+
name: "Enhancement/Feature request"
3+
about: Suggest adding an enhancement of a current feature or a new feature in Pyomo
4+
labels: enhancement
5+
6+
---
7+
8+
<!-- DO NOT DELETE OR IGNORE THIS TEMPLATE. Failing to adhere to this template and provide the necessary information may lead to your Issue being closed without consideration. -->
9+
10+
<!-- BEFORE SUBMITTING AN ENHANCEMENT REQUEST - please browse the open issues and the [Archived Design Discussions wiki page](https://github.com/Pyomo/pyomo/wiki/Archived-Design-Discussions).-->
11+
12+
## Summary
13+
14+
<!-- Please add a concise summary of your suggestion here. -->
15+
16+
### Rationale
17+
18+
<!-- Is your feature request related to a problem? Please describe it! -->
19+
20+
### Description
21+
22+
<!-- Describe the solution you'd like and the alternatives you have considered. -->
23+
24+
25+
### Additional information
26+
<!-- Add any other context about the feature request here. -->
27+
28+
29+
30+
<!-- If you want to ask a question (how to use Pyomo, what it can do, etc.), please refer to our [online documentation](https://github.com/Pyomo/pyomo#getting-help) on ways to get help. -->

‎.github/PULL_REQUEST_TEMPLATE.md‎

Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,26 @@
1+
<!-- ##################################################################### -->
2+
<!-- PLEASE READ BEFORE OPENING THIS PULL REQUEST -->
3+
4+
<!-- All changes must adhere to PEP8 standards as enforced by Black. -->
5+
<!-- If your changes do NOT adhere, the test suite will fail. -->
6+
<!-- Please read our Contributing guide for instructions on how to apply these standards. -->
7+
<!-- Contributing Guide: https://pyomo.readthedocs.io/en/stable/contribution_guide.html -->
8+
<!-- ##################################################################### -->
9+
10+
<!-- DO NOT DELETE OR IGNORE THIS TEMPLATE. Failing to adhere to this template and provide the necessary information may lead to your Pull Request being closed without consideration. -->
11+
12+
## Fixes # .
13+
14+
## Summary/Motivation:
15+
16+
17+
## Changes proposed in this PR:
18+
-
19+
-
20+
21+
### Legal Acknowledgement
22+
23+
By contributing to this software project, I have read the [contribution guide](https://pyomo.readthedocs.io/en/stable/contribution_guide.html) and agree to the following terms and conditions for my contribution:
24+
25+
1. I agree my contributions are submitted under the BSD license.
26+
2. I represent I am authorized to make the contributions and grant the license. If my employer has rights to intellectual property that includes these contributions, I represent that I have received permission to make contributions and grant the required license on behalf of that employer.

0 commit comments

Comments
 (0)