Update issue templates
Fixes #698. Further: - Add SUPPORT.md - Move community help files to .github folder
This commit is contained in:
parent
54c12fc59c
commit
eb02fa9726
6 changed files with 122 additions and 22 deletions
42
.github/ISSUE_TEMPLATE/bug_report.md
vendored
Normal file
42
.github/ISSUE_TEMPLATE/bug_report.md
vendored
Normal file
|
|
@ -0,0 +1,42 @@
|
|||
---
|
||||
name: Bug report
|
||||
about: Report reproducible software issues so we can improve
|
||||
title: ''
|
||||
labels: ''
|
||||
assignees: ''
|
||||
---
|
||||
|
||||
Please fill in the following information to report a problem with Cantera.
|
||||
If you have a question about using Cantera, please post it on our
|
||||
[Google Users' Group](https://groups.google.com/forum/#!forum/cantera-users).
|
||||
|
||||
**System information**
|
||||
|
||||
- Cantera version: [e.g. 2.4]
|
||||
- OS: [e.g. Windows 10]
|
||||
- Python/MATLAB version:
|
||||
|
||||
**Expected behavior**
|
||||
|
||||
A clear and concise description of what you expected to happen.
|
||||
|
||||
**Actual behavior**
|
||||
|
||||
A clear and concise description of what the bug is.
|
||||
|
||||
**To Reproduce**
|
||||
|
||||
Steps to reproduce the behavior:
|
||||
|
||||
1. Open '...'
|
||||
2. Run '....'
|
||||
3. See error '....'
|
||||
|
||||
**Attachments**
|
||||
|
||||
If applicable, attach scripts and/or input files to help explain your problem.
|
||||
Please do *not* attach screenshots of code or terminal output.
|
||||
|
||||
**Additional context**
|
||||
|
||||
Add any other context about the problem here.
|
||||
25
.github/ISSUE_TEMPLATE/feature_request.md
vendored
Normal file
25
.github/ISSUE_TEMPLATE/feature_request.md
vendored
Normal file
|
|
@ -0,0 +1,25 @@
|
|||
---
|
||||
name: Feature request
|
||||
about: Suggest a new feature to enhance Cantera's capabilities
|
||||
title: ''
|
||||
labels: ''
|
||||
assignees: ''
|
||||
---
|
||||
|
||||
**Is your feature request related to a problem? Please describe**
|
||||
|
||||
A clear and concise description of the problem you're trying to solve.
|
||||
|
||||
**Describe the desired solution**
|
||||
|
||||
A clear and concise description of a new feature and its application. For
|
||||
example, "It would be great if Cantera could..."
|
||||
|
||||
**Describe alternatives you have considered**
|
||||
|
||||
A clear and concise description of any alternative solutions or features you
|
||||
have considered.
|
||||
|
||||
**Additional context**
|
||||
|
||||
Add any other context about the feature request here.
|
||||
17
.github/PULL_REQUEST_TEMPLATE.md
vendored
Normal file
17
.github/PULL_REQUEST_TEMPLATE.md
vendored
Normal file
|
|
@ -0,0 +1,17 @@
|
|||
Thanks for contributing code! Please include a description of your change and
|
||||
check your PR against the list below (for further questions, refer to the
|
||||
[contributing guide](https://github.com/Cantera/cantera/blob/master/CONTRIBUTING.md)).
|
||||
|
||||
- [ ] There is a clear use-case for this code change
|
||||
- [ ] The commit message has a short title & references relevant issues
|
||||
- [ ] Build passes (`scons build` & `scons test`) and unit tests address code coverage
|
||||
|
||||
**Please fill in the issue number this pull request is fixing**
|
||||
|
||||
Fixes #
|
||||
|
||||
**Changes proposed in this pull request**
|
||||
|
||||
-
|
||||
-
|
||||
-
|
||||
38
.github/SUPPORT.md
vendored
Normal file
38
.github/SUPPORT.md
vendored
Normal file
|
|
@ -0,0 +1,38 @@
|
|||
# How to get support
|
||||
|
||||
> This project has a [Code of Conduct](https://github.com/Cantera/cantera/blob/master/CODE_OF_CONDUCT.md).
|
||||
> By interacting with this repository, organisation, or community you agree to
|
||||
> abide by its terms.
|
||||
|
||||
For **help**, **support** and **questions** please create a post on the
|
||||
**[Cantera Users' Group](https://groups.google.com/group/cantera-users)**.
|
||||
Any discussion of Cantera functionality such as how to use certain function
|
||||
calls, syntax problems, input files, etc. should be directed to the Users' Group.
|
||||
|
||||
Further, the **[Cantera Gitter Chat](https://gitter.im/Cantera/Lobby)** is an
|
||||
infrequently monitored chat room that can be used to discuss tangentially-related
|
||||
topics such as how to model the underlying physics of a problem, share cool
|
||||
applications that you have developed, etc.
|
||||
|
||||
Please **_do not_** raise an issue on GitHub unless it is a bug report or a
|
||||
feature request. Issues that do not fall into these categories will be closed.
|
||||
If you're not sure, please make a post on the
|
||||
[Users' Group](https://groups.google.com/group/cantera-users) and someone will
|
||||
be able to help you out.
|
||||
|
||||
## Documentation
|
||||
|
||||
The [documentation](https://cantera.org/documentation)
|
||||
offers a number of starting points:
|
||||
|
||||
- [Python tutorial](https://cantera.org/tutorials/python-tutorial.html)
|
||||
- [Application Examples in Python (Jupyter)](https://github.com/Cantera/cantera-jupyter#cantera-jupyter)
|
||||
- [A guide to Cantera's input file format](https://cantera.org/tutorials/input-files.html)
|
||||
- [Information about the Cantera community](https://cantera.org/community.html)
|
||||
|
||||
Documentation for the [development version of
|
||||
Cantera](https://cantera.org/documentation/dev-docs.html) is also available.
|
||||
|
||||
## Contributions
|
||||
|
||||
See [`CONTRIBUTING.md`](https://github.com/Cantera/cantera/blob/master/CONTRIBUTING.md) on how to contribute.
|
||||
|
|
@ -1,14 +0,0 @@
|
|||
### Cantera version
|
||||
|
||||
### Operating System
|
||||
|
||||
### Python/MATLAB version
|
||||
|
||||
### Expected Behavior
|
||||
|
||||
### Actual Behavior
|
||||
|
||||
### Steps to reproduce
|
||||
1.
|
||||
2.
|
||||
3.
|
||||
|
|
@ -1,8 +0,0 @@
|
|||
Please fill in the issue number this pull request is fixing:
|
||||
|
||||
Fixes #
|
||||
|
||||
Changes proposed in this pull request:
|
||||
-
|
||||
-
|
||||
-
|
||||
Loading…
Add table
Reference in a new issue