Skip to content

Commit 1b3cb6b

Browse files
SabineHaasSabineHaas
committed
Add to Contributing section in documentation
1 parent 39a047e commit 1b3cb6b

File tree

2 files changed

+63
-8
lines changed

2 files changed

+63
-8
lines changed

‎README.rst‎

Lines changed: 32 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ Introduction
77
=============
88

99
The windpowerlib is a library that provides a set of functions and classes to calculate the power output of wind turbines. It was originally part of the
10-
`feedinlib <https://github.com/oemof/feedinlib>`_ (windpower and pv) but was taken out to build up a community concentrating on wind power models.
10+
`feedinlib <https://github.com/oemof/feedinlib>`_ (windpower and photovoltaic) but was taken out to build up a community concentrating on wind power models.
1111

1212
For a quick start see the `Examples and basic usage <http://windpowerlib.readthedocs.io/en/stable/getting_started.html#examplereference-label>`_ section.
1313

@@ -66,12 +66,40 @@ The usage of further functions are shown in a second example. As the basic usage
6666
Contributing
6767
==============
6868

69-
Clone/Fork: https://github.com/wind-python/windpowerlib
69+
We are warmly welcoming all who want to contribute to the windpowerlib. If you are interested in wind models and want to help improving the existing model do not hesitate to contact us.
7070

71-
If you are interested in wind models and want to help improve the existing model do not hesitate to contact us.
72-
As the windpowerlib started with contributors from the `oemof developer group <https://github.com/orgs/oemof/teams/oemof-developer-group>`_ we use the same
71+
Clone: https://github.com/wind-python/windpowerlib and install the cloned repository using pip:
72+
73+
.. code:: bash
74+
75+
pip install -e /path/to/the/repository
76+
77+
As the windpowerlib started with contributors from the `oemof developer group <https://github.com/orgs/oemof/teams/oemof-developer-group>`_ we use the same
7378
`developer rules <http://oemof.readthedocs.io/en/stable/developing_oemof.html>`_.
7479

80+
**How to create a pull request:**
81+
82+
* `Fork <https://help.github.com/articles/fork-a-repo>`_ the windpowerlib repository to your own github account.
83+
* Change, add or remove code.
84+
* Commit your changes.
85+
* Create a `pull request <https://guides.github.com/activities/hello-world/>`_ and describe what you will do and why.
86+
* Wait for approval.
87+
88+
**Generally the following steps are required when changing, adding or removing code:**
89+
90+
* Add new tests if you have written new functions/classes
91+
* Add/change the documentation (new feature, API changes ...)
92+
* Add a whatsnew entry and your name to Contributors
93+
* Check if all tests still work by simply executing pytest in your windpowerlib directory:
94+
95+
.. role:: bash(code)
96+
:language: bash
97+
98+
.. code:: bash
99+
100+
pytest
101+
102+
75103
Citing the windpowerlib
76104
========================
77105

‎doc/getting_started.rst‎

Lines changed: 31 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ Introduction
66
=============
77

88
The windpowerlib is a library that provides a set of functions and classes to calculate the power output of wind turbines. It was originally part of the
9-
`feedinlib <https://github.com/oemof/feedinlib>`_ (windpower and pv) but was taken out to build up a community concentrating on wind power models.
9+
`feedinlib <https://github.com/oemof/feedinlib>`_ (windpower and photovoltaic) but was taken out to build up a community concentrating on wind power models.
1010

1111
For a quick start see the :ref:`examplereference-label` section.
1212

@@ -63,12 +63,39 @@ Further functionalities are shown in a second example. As the basic usage exampl
6363
Contributing
6464
==============
6565

66-
Clone/Fork: https://github.com/wind-python/windpowerlib
66+
We are warmly welcoming all who want to contribute to the windpowerlib. If you are interested in wind models and want to help improving the existing model do not hesitate to contact us.
6767

68-
If you are interested in wind models and want to help improve the existing model do not hesitate to contact us.
69-
As the windpowerlib started with contributors from the `oemof developer group <https://github.com/orgs/oemof/teams/oemof-developer-group>`_ we use the same
68+
Clone: https://github.com/wind-python/windpowerlib and install the cloned repository using pip:
69+
70+
.. code:: bash
71+
72+
pip install -e /path/to/the/repository
73+
74+
As the windpowerlib started with contributors from the `oemof developer group <https://github.com/orgs/oemof/teams/oemof-developer-group>`_ we use the same
7075
`developer rules <http://oemof.readthedocs.io/en/stable/developing_oemof.html>`_.
7176

77+
**How to create a pull request:**
78+
79+
* `Fork <https://help.github.com/articles/fork-a-repo>`_ the windpowerlib repository to your own github account.
80+
* Change, add or remove code.
81+
* Commit your changes.
82+
* Create a `pull request <https://guides.github.com/activities/hello-world/>`_ and describe what you will do and why.
83+
* Wait for approval.
84+
85+
**Generally the following steps are required when changing, adding or removing code:**
86+
87+
* Add new tests if you have written new functions/classes
88+
* Add/change the documentation (new feature, API changes ...)
89+
* Add a whatsnew entry and your name to Contributors
90+
* Check if all tests still work by simply executing pytest in your windpowerlib directory:
91+
92+
.. role:: bash(code)
93+
:language: bash
94+
95+
.. code:: bash
96+
97+
pytest
98+
7299
Citing the windpowerlib
73100
========================
74101

0 commit comments

Comments
 (0)