Skip to content

Commit

Permalink
Merge pull request #5 from joergbuchwald/devel
Browse files Browse the repository at this point in the history
Devel
  • Loading branch information
joergbuchwald authored Apr 16, 2021
2 parents 5656790 + ac6f18d commit c4b85ae
Show file tree
Hide file tree
Showing 36 changed files with 530 additions and 199 deletions.
11 changes: 11 additions & 0 deletions AUTHORS.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
# ogs6py

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


## Main Authors

- [Jörg Buchwald](https://github.com/joergbuchwald), Email: <[email protected]>
- [Tom Fischer](https://github.com/TomFischer)
- [Dmitry Yu. Naumov](https://github.com/endJunction)
13 changes: 13 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
# Changelog

All notable changes to **ogs6py** will be documented in this file.


## [Unreleased]

### Bugfixes

### Additions

### Changes

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 ogs6py

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/joergbuchwald/ogs6py/issues)
- If the bug wasn't already reported, open a
[new issue](https://github.com/joergbuchwald/ogs6py/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 ogs6py
print(ogs6py.__version__)
```


## Do you have suggestions for new features?

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


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

- Fork the repo on [GitHub](https://github.com/joergbuchwald/ogs6py).
- Add yourself to AUTHORS.md (if you want to).
- Add some tests if possible.
- Push to your fork and submit a pull request.

21 changes: 21 additions & 0 deletions LICENSE
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
The MIT License (MIT)

Copyright (c) 2019-2021 Joerg Buchwald

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.
4 changes: 4 additions & 0 deletions MANIFEST.in
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
include MANIFEST.in
include setup.py
recursive-include ogs6py *.py
include LICENSE
Loading

0 comments on commit c4b85ae

Please sign in to comment.