-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
1 changed file
with
9 additions
and
14 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,33 +1,28 @@ | ||
# Filtered Models | ||
Filtered models for the hydrodynamics and heat transfer associated with horizontal cylindrical objects in a flow path. | ||
|
||
## Development Practices | ||
|
||
* Code development will be peformed in a forked copy of the repo. Commits will not be | ||
made directly to the repo. Developers will submit a pull request that is then merged | ||
by another team member, if another team member is available. | ||
* Each pull request should contain only related modifications to a feature or bug fix. | ||
* Sensitive information (secret keys, usernames etc) and configuration data | ||
(e.g database host port) should not be checked in to the repo. | ||
* A practice of rebasing with the main repo should be used rather that merge commmits. | ||
|
||
## Getting Started | ||
|
||
See installation and user guide documents: | ||
* [Gas Particle Cylinder 2D Models](./gas-particle-cylinder_2d_models/docs) | ||
* [Gas Solid 3D Models](./gas-solid-3d-models/docs) | ||
|
||
## Authors | ||
|
||
* William Lane | ||
|
||
See also the list of [contributors](../../contributors) who participated in this project. | ||
|
||
## Versioning | ||
## Development Practices | ||
* Code development will be peformed in a forked copy of the repo. Commits will not be | ||
made directly to the repo. Developers will submit a pull request that is then merged | ||
by another team member, if another team member is available. | ||
* Each pull request should contain only related modifications to a feature or bug fix. | ||
* Sensitive information (secret keys, usernames etc) and configuration data | ||
(e.g database host port) should not be checked in to the repo. | ||
* A practice of rebasing with the main repo should be used rather that merge commmits. | ||
|
||
## Versioning | ||
We use [SemVer](http://semver.org/) for versioning. For the versions available, | ||
see the [releases](../../releases) or [tags](../../tags) for this repository. | ||
|
||
## License & Copyright | ||
|
||
See [LICENSE.md](LICENSE.md) file for details |