Skip to content

Commit

Permalink
Minor changes to CONTRIBUTING.md (#856)
Browse files Browse the repository at this point in the history
* Minor changes to CONTRIBUTING.md

- Added reference to new `Cantera/enhancements` GitHub repo.
- Added explicit instruction to push to forked copy of the repo, before
submitting a PR.

* Add link to Cantera/enhancements

Co-authored-by: Bryan W. Weber <[email protected]>
  • Loading branch information
decaluwe and bryanwweber authored Jun 1, 2020
1 parent 0089281 commit f973215
Showing 1 changed file with 9 additions and 5 deletions.
14 changes: 9 additions & 5 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,8 @@
# Contributing to Cantera

* For significant changes, consider starting a discussion on the Cantera
Users' Group to plan your modifications so that they can be implemented
* For significant changes, please start a discussion on the Cantera
Users' Group or create an issue on the [Cantera/enhancements](https://github.com/Cantera/enhancements/issues/new/choose) repository
on GitHub to plan your modifications so that they can be implemented
efficiently and in a way that doesn't conflict with any other planned
future development
* Fork the `Cantera/cantera` repository on Github
Expand Down Expand Up @@ -29,9 +30,12 @@
onto the most recent `HEAD` commit of `master`.
* Periodically run the test suite (`scons test`) to make sure that your
changes are not causing any test failures.
* Submit a Pull Request on Github. Check the results of the continuous-
integration tests run using Travis and AppVeyor and resolve any issues that
arise.
* Push the changes on your new feature branch to your forked copy of the
`Cantera/cantera` repository on GitHub.

* Submit a Pull Request on Github, from your forked copy. Check the results
of the continuous-integration tests run using Travis and AppVeyor and resolve
any issues that arise.
* Additional discussion of good Git & Github workflow is provided at
http://matplotlib.org/devel/gitwash/development_workflow.html and
https://docs.scipy.org/doc/numpy-1.15.0/dev/gitwash/development_workflow.html
Expand Down

0 comments on commit f973215

Please sign in to comment.