Skip to content

Include assert message in contribute and PR template#579

Merged
smartie2076 merged 5 commits intodevfrom
fix/PR-template
Sep 30, 2020
Merged

Include assert message in contribute and PR template#579
smartie2076 merged 5 commits intodevfrom
fix/PR-template

Conversation

@Bachibouzouk
Copy link
Copy Markdown
Collaborator

@Bachibouzouk Bachibouzouk commented Sep 26, 2020

Fix #540

Changes proposed in this pull request:

  • Modify PR template to precise to add assert message and link to example docstring
  • Update CONTRIBUTING to add a "Write test for your code" section before the "Run tests locally" one

The following steps were realized, as well (if applies):

  • Write docstrings to your code
  • For new functionalities: Explain in readthedocs
  • Update the CHANGELOG.md

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

Copy link
Copy Markdown
Collaborator

@smartie2076 smartie2076 left a comment

Choose a reason for hiding this comment

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

You need to update the changelog ;)

fails (`assert <condition>, <string message>`). It could be very useful to understand what exactly
went wrong in the test for a developer 6 months from now.
If you are testing a function in a module, it would be nice to indicate in the docstring of this
function (under the section `Notes`) that this test exist, cf [example docstring](https://mvs-eland.readthedocs.io/en/latest/Developing.html#format-of-docstrings)!
Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

What does cf mean?

Copy link
Copy Markdown
Collaborator Author

Choose a reason for hiding this comment

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

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

Haha, okay. Thought it was a typo.

@Bachibouzouk
Copy link
Copy Markdown
Collaborator Author

@smartie2076 you can push when the test have ran

@smartie2076 smartie2076 merged commit d360612 into dev Sep 30, 2020
@smartie2076 smartie2076 deleted the fix/PR-template branch September 30, 2020 10:01
@Bachibouzouk Bachibouzouk mentioned this pull request Oct 5, 2020
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.

Debug messages for pytest assertion errors

2 participants