Skip to content

Pp/#737 update contributingmd #995

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 5 commits into from
Jan 25, 2024
Merged

Pp/#737 update contributingmd #995

Show file tree
Hide file tree
Changes from 3 commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
1f4f462
- Delete JavaDoc link in line 19.
pierrepetersmeier Jan 24, 2024
04d11e1
-correct GitHub links
pierrepetersmeier Jan 24, 2024
9e49c1f
- Deleted JavaDoc sentence in line 54.
pierrepetersmeier Jan 24, 2024
2c90dd8
- Added JavaDoc sentence in line 54.
pierrepetersmeier Jan 25, 2024
ba2fa58
-delete space
pierrepetersmeier Jan 25, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 10 additions & 1 deletion AUTHORS
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,10 +1,14 @@
Copyright (c) 2023, Institute of Energy Systems, Energy Efficiency and Energy Economics (ie3)
Copyright (c) 2024, Institute of Energy Systems, Energy Efficiency and Energy Economics (ie3)
All rights reserved.

Lead Developers:
- Johannes Hiry
- Chris Kittl
- Debopama Sen-Sarma
- Thomas Oberließen
- Daniel Feismann
- Johannes Bao
- Sebastian Peter

Main Contributers:
- Johannes Hiry - https://github.com/johanneshiry
Expand All @@ -20,3 +24,8 @@ Main Contributers:
- Marius Staudt - https://github.com/staudtMarius
- Lara Roumeliotis - https://github.com/lararou
- Vicky Bung - https://github.com/vickybung1
- Daniel Feismann - https://github.com/danielfeismann
- Johannes Bao - https://github.com/jo-bao
- Julian Hohmann - https://github.com/julianhohmann
- Simon Huette - https://github.com/SimonHuette
- Pierre Petersmeier - http://github.com/pierrepetersmeier
8 changes: 2 additions & 6 deletions CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ With this document we would like to give you some orientation on how you can con
## Testing and reporting bugs
We really appreciate your usage of this project.
Whenever you find a bug, it would be nice to check, if this isn't a feature to us. :wink:
You may find extensive information about the intended behaviour when you [Read the Docs](https://powersystemdatamodel.readthedocs.io/en/latest/) or within the [javadoc](https://ie3-institute.github.io/PowerSystemDataModel/javadoc/).
You may find extensive information about the intended behaviour when you [Read the Docs](https://powersystemdatamodel.readthedocs.io/en/latest/).
If you still think it's a bug, please raise an [issue](https://guides.github.com/features/issues/) for us.
Considering the following aspects in your inquiry, assists us in helping you:

Expand Down Expand Up @@ -51,7 +51,6 @@ In order to maintain a consistent project, we thought of some general design gui

* We :heart: **immutability**. Therefore, please don't provide setters and use proper instantiation instead.
* `double a = b * pow(x, j)`? :hand: Please **be expressive** in what you code!
* Document your code with **javadoc**.

### Testing
Ensure the proper function of your code by [test driven development (TDD)](https://www.guru99.com/test-driven-development.html).
Expand All @@ -67,9 +66,6 @@ Before marking the pull request as 'ready to review', take these precautionary a
`gradle finalizePR` summarizes all of these steps .

## For any doubts
... please contact
* Johannes (@johanneshiry),
* Debopama (@sensarmad) or
* Chris (@ckittl)
... please contact [us](AUTHORS)

We are happy to help! :smiley: