Skip to content
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.

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

Correct description of installation requirements in contributing.md #306

Merged
merged 2 commits into from
May 10, 2021

Conversation

SabineHaas
Copy link
Collaborator

@SabineHaas SabineHaas commented May 7, 2021

Fix #Issue

Changes proposed in this pull request:

  • Corrected description of installation requirements in contributing.md

The following steps were realized, as well (required):

  • Update the CHANGELOG.md
  • Check if full simulation tests pass locally (EXECUTE_TESTS_ON=master pytest)

Also the following steps were realized (if applies):

  • Use in-line comments to explain your code
  • Write docstrings to your code
  • For new functionalities: Explain in readthedocs
  • Write test(s) for your new patch of code

Please mark above checkboxes as following:

  • Open
  • Done

In case of an error due to linting, run black . --exclude docs/ and push your changes.
Note that in case you do not fix a whole issue you should start your PR with Address #xyz.

For more information on how to contribute check the CONTRIBUTING.md.

@SabineHaas SabineHaas self-assigned this May 7, 2021
@SabineHaas SabineHaas requested a review from Piranias May 7, 2021 10:55
@SabineHaas SabineHaas merged commit 285a6e5 into dev May 10, 2021
@SabineHaas SabineHaas deleted the fix/installation_documentation branch May 10, 2021 09:58
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants