Skip to content

Commit 9609557

Browse files
authored
Updated README.md
1 parent 0cd12fc commit 9609557

1 file changed

Lines changed: 34 additions & 0 deletions

File tree

README.md

Lines changed: 34 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1 +1,35 @@
11
# ProcessModels_bundle
2+
A suite of process models implemented in both Aspen Custom Modeler and gPROMS Model Builder, as well as models implemented within Aspen Plus and Aspen Plus Dynamics.
3+
4+
## Development Practices
5+
6+
* Code development will be peformed in a forked copy of the repo. Commits will not be
7+
made directly to the ngt-archive repo. Developers will submit a pull
8+
request that is then merged by another team member, if another team member is available.
9+
* Each pull request should contain only related modifications to a feature or bug fix.
10+
* Sensitive information (secret keys, usernames etc) and configuration data
11+
(e.g database host port) should not be checked in to the repo.
12+
* A practice of rebasing with the main repo should be used rather that merge commmits.
13+
14+
## Getting Started
15+
16+
TBD
17+
18+
## Authors
19+
20+
* Jim Leek
21+
22+
See also the list of [contributors](https://github.com/CCSI-Toolset/ProcessModels_bundle/contributors) who participated in this project.
23+
24+
## Versioning
25+
26+
We use [SemVer](http://semver.org/) for versioning. For the versions available,
27+
see the [tags on this repository](https://github.com/CCSI-Toolset/ProcessModels_bundle/tags).
28+
29+
## License
30+
31+
See [LICENSE.md](LICENSE.md) file for details
32+
33+
## Copyright Notice
34+
35+
TBD

0 commit comments

Comments
 (0)