Skip to content

Commit 7607530

Browse files
committed
added more information about package
1 parent 4d1ee28 commit 7607530

File tree

3 files changed

+55
-0
lines changed

3 files changed

+55
-0
lines changed

AUTHORS.md

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
# ogs5py
2+
3+
ogs5py is available on [GitHub](https://github.com/GeoStat-Framework/ogs5py)
4+
and was created by following people.
5+
6+
7+
## Main Authors
8+
9+
- [Sebastian Müller](https://github.com/MuellerSeb), Email: <[email protected]>
10+
11+
12+
## Contributors (in order of contributions)
13+
14+
- Falk Heße, Email: <[email protected]>
15+
- Miao Jing, Email: <[email protected]>

CONTRIBUTING.md

Lines changed: 34 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,34 @@
1+
# How to Contribute to ogs5py
2+
3+
We are happy about all contributions! :thumbsup:
4+
5+
6+
## Did you find a bug?
7+
8+
- Ensure that the bug was not already reported under
9+
[GitHub issues](https://github.com/GeoStat-Framework/ogs5py/issues)
10+
- If the bug wasn't already reported, open a
11+
[new issue](https://github.com/GeoStat-Framework/ogs5py/issues) with a clear
12+
description of the problem and if possible with a
13+
[minimal working example](https://en.wikipedia.org/wiki/Minimal_working_example).
14+
- please add the version number to the issue:
15+
16+
```python
17+
import ogs5py
18+
print(ogs5py.__version__)
19+
```
20+
21+
22+
## Do you have suggestions for new features?
23+
24+
Open a [new issue](https://github.com/GeoStat-Framework/ogs5py/issues)
25+
with your idea or suggestion and we'd love to discuss about it.
26+
27+
28+
## Do you want to enhance GSTools or fix something?
29+
30+
- Fork the repo on [GitHub](https://github.com/GeoStat-Framework/ogs5py).
31+
- Add yourself to AUTHORS.md (if you want to).
32+
- We use the black code format, please use the script `black --line-length 79 ogs5py/` after you have written your code.
33+
- Add some tests if possible.
34+
- Push to your fork and submit a pull request.

MANIFEST.in

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
include MANIFEST.in
2+
include setup.py
3+
recursive-include ogs5py *.py
4+
recursive-include docs/source *
5+
include docs/Makefile docs/requirements.txt
6+
include LICENSE

0 commit comments

Comments
 (0)