diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md new file mode 100644 index 000000000..faae854eb --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug_report.md @@ -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. diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md new file mode 100644 index 000000000..9dbfd8f04 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/feature_request.md @@ -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. diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md new file mode 100644 index 000000000..b29a4a83d --- /dev/null +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -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** + +- +- +- diff --git a/.github/SUPPORT.md b/.github/SUPPORT.md new file mode 100644 index 000000000..fe2c98d29 --- /dev/null +++ b/.github/SUPPORT.md @@ -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. diff --git a/ISSUE_TEMPLATE.md b/ISSUE_TEMPLATE.md deleted file mode 100644 index b85785857..000000000 --- a/ISSUE_TEMPLATE.md +++ /dev/null @@ -1,14 +0,0 @@ -### Cantera version - -### Operating System - -### Python/MATLAB version - -### Expected Behavior - -### Actual Behavior - -### Steps to reproduce -1. -2. -3. diff --git a/PULL_REQUEST_TEMPLATE.md b/PULL_REQUEST_TEMPLATE.md deleted file mode 100644 index 9c5ad187a..000000000 --- a/PULL_REQUEST_TEMPLATE.md +++ /dev/null @@ -1,8 +0,0 @@ -Please fill in the issue number this pull request is fixing: - -Fixes # - -Changes proposed in this pull request: -- -- --