Skip to content

Latest commit

 

History

History
163 lines (97 loc) · 6.83 KB

CONTRIBUTING.rst

File metadata and controls

163 lines (97 loc) · 6.83 KB
Raw

Get in Touch!

You have found a bug in pandapipes or have a suggestion for a new functionality? Then get in touch with us by opening up an issue on the pandapipes issue board to discuss possible new developments with the community and the maintainers.

Setup your git repository

Note: The following setup is just a suggestion of how to setup your repository and is supposed to make contributing easier, especially for newcomers. If you have a different setup that you are more comfortable with, you do not have to adopt this setup.

If you want to contribute for the first time, you can set up your environment like this:

  1. If you have not done it yet: install git and create a github account
  2. Create a fork of the official pandapipes repository by clicking on "Fork" on the official pandapipes repository (see https://help.github.com/articles/fork-a-repo/)

  3. Clone the forked repository to your local machine: :

    git clone https://github.com/YOUR-USERNAME/pandapipes.git

  4. Copy the following configuration at the bottom of to the pandapipes/.git/config file (the .git folder is hidden, so you might have to enable showing hidden folders) and insert your github username: :

    [remote "origin"]
    url = https://github.com/e2nIEE/pandapipes.git
    fetch = +refs/heads/*:refs/remotes/pp/*
    pushurl = https://github.com/YOUR-USERNAME/pandapipes.git
[remote "pp"]
    url = https://github.com/e2nIEE/pandapipes.git
    fetch = +refs/heads/*:refs/remotes/pp/*
[remote "pp_fork"]
    url = https://github.com/YOUR-USERNAME/pandapipes.git
    fetch = +refs/heads/*:refs/remotes/pp_fork/*
[branch "develop"]
    remote = origin
    merge = refs/heads/develop

The develop branch is now configured to automatically track the official pandapipes develop branch. So if you are on the develop branch and use: :

git pull

your local repository will be updated with the newest changes in the official pandapipes repository.

Since you cannot push directly to the official pandapipes repository, if you are on develop and do: :

git push

your push is by default routed to your own fork instead of the official pandapipes repository with the setting as defined above.

If this is to implicit for you, you can always explicitely use the remotes "pp" and "pp_fork" to push and pull from the different repositories: :

git pull pp develop
git push pp_fork develop

Contribute

All contributions to the pandapipes repository are made through pull requests to the develop branch. You can either submit a pull request from the develop branch of your fork or create a special feature branch that you keep the changes on. A feature branch is the way to go if you have multiple issues that you are working on in parallel and want to submit with seperate pull requests. If you only have small, one-time changes to submit, you can also use the develop branch to submit your pull request.

Note: The following guide assumes the remotes are set up as described above. If you have a different setup, you will have to adapt the commands accordingly.

Contribute from your develop branch

  1. Check out the develop branch on your local machine: :

    git checkout develop

  2. Update your local copy to the most recent version of the pandpipes develop branch: :

    git pull
  3. Make changes in the code

  4. Add and commit your changes: :

    git add --all
git commit -m"commit message"

    If there is an open issue that the commit belongs to, reference the issue in the commit message, for example for issue 3: :

    git commit -m"commit message #3"

  5. Push your changes to your fork: :

    git push
  6. Put in a Pull request to the main repository: https://help.github.com/articles/creating-a-pull-request-from-a-fork/
  7. For each Pull request, some checks will start automatically. It is required that the travis-ci check passes (i. e. all pandapipes tests pass) to enable merging into the develop branch.

  8. If you want to amend the pull request (for example because tests are failing, or because the community/maintainers have asked for modifications), simply push more commits to the branch: :

    git add --all
git commit -m"I have updated the pull request after discussions #3"
git push

    The pull request will be automatically updated.

Contribute from a feature branch

  1. Check out the develop branch on your local machine: :

    git checkout develop

  2. Update your local copy to the most recent version of the pandpipes develop branch: :

    git pull

  3. Create a new feature branch: :

    git checkout -b my_branch
  4. Make changes in the code

  5. Add and commit your change: :

    git add --all
git commit -m"commit message"

    If there is an open issue that the commit belongs to, reference the issue in the commit message, for example for issue 3: :

    git commit -m"commit message #3"

  6. Push your changes to your fork: :

    git push -u pp_fork my_branch

    this pushes the new branch to your fork and also sets up the remote tracking.

  7. Put in a Pull request to the official repository (see https://help.github.com/articles/creating-a-pull-request-from-a-fork/).
  8. For each Pull request, some checks will start automatically. It is required that the travis-ci check passes (i. e. all pandapipes tests pass) to enable merging into the develop branch.

  9. If you want to amend the pull request (for example because tests are failing, or because the community/maintainers have asked for modifications), simply push more commits to the branch. Since the remote tracking branch has been set up, this is as easy as: :

    git add --all
git commit -m"I have updated the pull request after discussions #3"
git push
  10. If the pull request was merged and you don't expect further development on this feature, you can delete the feature branch to keep your repository clean.

Test Suite

pandapipes uses pytest for automatic software testing.

Making sure you don't break anything

If you make changes to pandapipes that you plan to submit, first make sure that all tests are still passing. You can do this locally with: :

from pandapipes.test.run_tests import run_tests
run_tests()

Adding Tests for new functionality

If you have added new functionality, you should also add a new function that tests this functionality. pytest automatically detects all functions in the pandapipes/test folder that start with 'test' and are located in a file that also starts with 'test' as relevant test cases.

Tests with pytest can be quite complex. For how to handle e.g. pytest fixtures, xfailing tests etc. refer to the documentation of pytest.