Skip to content

Commit

Permalink
added more information about package
Browse files Browse the repository at this point in the history
  • Loading branch information
MuellerSeb committed Jan 21, 2019
1 parent 4d1ee28 commit 7607530
Show file tree
Hide file tree
Showing 3 changed files with 55 additions and 0 deletions.
15 changes: 15 additions & 0 deletions AUTHORS.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
# ogs5py

ogs5py is available on [GitHub](https://github.com/GeoStat-Framework/ogs5py)
and was created by following people.


## Main Authors

- [Sebastian Müller](https://github.com/MuellerSeb), Email: <sebastian@geostat-framework.org>


## Contributors (in order of contributions)

- Falk Heße, Email: <falk.hesse@ufz.de>
- Miao Jing, Email: <miao.jing@ufz.de>
34 changes: 34 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,34 @@
# How to Contribute to ogs5py

We are happy about all contributions! :thumbsup:


## Did you find a bug?

- Ensure that the bug was not already reported under
[GitHub issues](https://github.com/GeoStat-Framework/ogs5py/issues)
- If the bug wasn't already reported, open a
[new issue](https://github.com/GeoStat-Framework/ogs5py/issues) with a clear
description of the problem and if possible with a
[minimal working example](https://en.wikipedia.org/wiki/Minimal_working_example).
- please add the version number to the issue:

```python
import ogs5py
print(ogs5py.__version__)
```


## Do you have suggestions for new features?

Open a [new issue](https://github.com/GeoStat-Framework/ogs5py/issues)
with your idea or suggestion and we'd love to discuss about it.


## Do you want to enhance GSTools or fix something?

- Fork the repo on [GitHub](https://github.com/GeoStat-Framework/ogs5py).
- Add yourself to AUTHORS.md (if you want to).
- We use the black code format, please use the script `black --line-length 79 ogs5py/` after you have written your code.
- Add some tests if possible.
- Push to your fork and submit a pull request.
6 changes: 6 additions & 0 deletions MANIFEST.in
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
include MANIFEST.in
include setup.py
recursive-include ogs5py *.py
recursive-include docs/source *
include docs/Makefile docs/requirements.txt
include LICENSE

0 comments on commit 7607530

Please sign in to comment.