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

How to release section in contributing.md #259

Merged
merged 6 commits into from
Mar 24, 2021
Merged

Conversation

SabineHaas
Copy link
Collaborator

@SabineHaas SabineHaas commented Mar 22, 2021

Fix #Issue

Changes proposed in this pull request:

  • Added How to release section in contributing.md
  • Tested it with first github release v0.0.1
  • Adapted PR template: from now on changelog entry necessary

The following steps were realized, as well (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
  • Update the CHANGELOG.md (let's start this after the first release)
  • Apply black (black . --exclude docs/)
  • Check if full simulation tests pass locally (EXECUTE_TESTS_ON=master pytest)

Please mark above checkboxes as following:

  • Open
  • Done

❌ Check not applicable to this PR

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

@SabineHaas SabineHaas self-assigned this Mar 22, 2021
@SabineHaas SabineHaas marked this pull request as ready for review March 22, 2021 14:19
Copy link
Collaborator

@MaGering MaGering left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good! Can't wait for 5. in After the release. :-D

@SabineHaas SabineHaas merged commit d6a13ed into dev Mar 24, 2021
@SabineHaas SabineHaas deleted the feature/how_to_release branch March 24, 2021 09:38
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