Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update GitHub documentation and templates #890

Merged
merged 2 commits into from
Jul 1, 2020
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
26 changes: 13 additions & 13 deletions .github/ISSUE_TEMPLATE/bug_report.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,28 +8,28 @@ 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). Feature enhancements should be discussed in the dedicated Cantera enhancements repository (https://github.com/Cantera/enhancements/new/choose) -->

**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**
**Problem description**

<!-- A clear and concise description of what the bug is. -->

**To Reproduce**
**Steps to reproduce**

Steps to reproduce the behavior:
<!-- A minimal, complete, and reproducible example demonstrating the problem. See https://stackoverflow.com/help/minimal-reproducible-example for additional suggestions on how to create such an example. -->

1. Open '...'
2. Run '....'
3. See error '....'

**Behavior**

<!-- Describe the result of executing the above steps, and how this differs from what you expect to happen. -->

**System information**

- Cantera version: [for example, 2.5.0 or the git commit hash]
- OS: [for example, Windows 10]
- Python/MATLAB/other software versions:

**Attachments**

<!-- If applicable, attach scripts and/or input files to help explain your problem. Please do *not* attach screenshots of code or terminal output. -->
Expand Down
20 changes: 10 additions & 10 deletions .github/PULL_REQUEST_TEMPLATE.md
Original file line number Diff line number Diff line change
@@ -1,18 +1,18 @@
<!-- 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). -->
<!-- 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/main/CONTRIBUTING.md). -->

**Checklist**
**Changes proposed in this pull request**

- [ ] 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
- [ ] The pull request is ready for review
-
-
-

**If applicable, fill in the issue number this pull request is fixing**

Fixes #

**Changes proposed in this pull request**
**Checklist**

-
-
-
- [ ] 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
- [ ] The pull request is ready for review
4 changes: 2 additions & 2 deletions .github/SUPPORT.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# How to get support

> This project has a [Code of Conduct](https://github.com/Cantera/cantera/blob/master/CODE_OF_CONDUCT.md).
> This project has a [Code of Conduct](https://github.com/Cantera/cantera/blob/main/CODE_OF_CONDUCT.md).
> By interacting with this repository, organisation, or community you agree to
> abide by its terms.

Expand Down Expand Up @@ -35,4 +35,4 @@ 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.
See [`CONTRIBUTING.md`](https://github.com/Cantera/cantera/blob/main/CONTRIBUTING.md) on how to contribute.
12 changes: 6 additions & 6 deletions .github/workflows/main.yml
Original file line number Diff line number Diff line change
Expand Up @@ -5,14 +5,14 @@ on:
# Build on tags that look like releases
tags:
- v*
# Build when master or testing is pushed to
# Build when main or testing is pushed to
branches:
- master
- main
- testing
pull_request:
# Build when a pull request targets master
# Build when a pull request targets main
branches:
- master
- main

jobs:
ubuntu-multiple-pythons:
Expand Down Expand Up @@ -138,13 +138,13 @@ jobs:
# machine that has previously logged in to cantera.org and trusts
# that it logged in to the right machine
- name: Set up SSH key and host for deploy
if: github.event_name == 'push' && github.repository_owner == 'Cantera' && github.ref == 'master'
if: github.event_name == 'push' && github.repository_owner == 'Cantera' && github.ref == 'main'
uses: shimataro/ssh-key-action@v2
with:
key: ${{ secrets.CTDEPLOY_KEY }}
known_hosts: ${{ secrets.CTDEPLOY_HOST }}
- name: Upload the docs
if: github.event_name == 'push' && github.repository_owner == 'Cantera' && github.ref == 'master'
if: github.event_name == 'push' && github.repository_owner == 'Cantera' && github.ref == 'main'
env:
RSYNC_USER: "ctdeploy"
RSYNC_SERVER: "cantera.org"
Expand Down
8 changes: 4 additions & 4 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@
future development
* Fork the `Cantera/cantera` repository on Github
* Clone your new repository or add it as a remote to an existing repository
* Check out the existing `master` branch, then start a new feature branch for
* Check out the existing `main` branch, then start a new feature branch for
your work
* When making changes, write code that is consistent with the surrounding code
(see the [style guidelines](#style-guidelines) below)
Expand All @@ -26,8 +26,8 @@
* Use Git's history-rewriting features (i.e., `git rebase -i`; see
https://help.github.com/articles/about-git-rebase/) to organize your commits
and squash "fixup" commits and reversions.
* Do not merge your branch with `master`. If needed, you should rebase your branch
onto the most recent `HEAD` commit of `master`.
* Do not merge your branch with `main`. If needed, you should rebase your branch
onto the most recent `HEAD` commit of `main`.
* Periodically run the test suite (`scons test`) to make sure that your
changes are not causing any test failures.
* Push the changes on your new feature branch to your forked copy of the
Expand All @@ -40,7 +40,7 @@
http://matplotlib.org/devel/gitwash/development_workflow.html and
https://docs.scipy.org/doc/numpy-1.15.0/dev/gitwash/development_workflow.html
* Cantera is licensed under a [BSD
license](https://github.com/Cantera/cantera/blob/master/License.txt) which
license](https://github.com/Cantera/cantera/blob/main/License.txt) which
allows others to freely modify the code, and if your Pull Request is accepted,
then that code will be release under this license as well. The copyright for
Cantera is held collectively by the contributors. If you have made a
Expand Down
4 changes: 2 additions & 2 deletions README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -158,8 +158,8 @@ development of Cantera through NumFOCUS.
.. |doi| image:: https://zenodo.org/badge/DOI/10.5281/zenodo.170284.svg
:target: https://doi.org/10.5281/zenodo.1174508

.. |codecov| image:: https://img.shields.io/codecov/c/github/Cantera/cantera/master.svg
:target: https://codecov.io/gh/Cantera/cantera?branch=master
.. |codecov| image:: https://img.shields.io/codecov/c/github/Cantera/cantera/main.svg
:target: https://codecov.io/gh/Cantera/cantera?branch=main

.. |release| image:: https://img.shields.io/github/release/cantera/cantera.svg
:target: https://github.com/Cantera/cantera/releases
Expand Down