Add testing section to contribution guidelines #366
Conversation
| @@ -2,7 +2,7 @@ | |||
|
|
|||
| Hi! Thanks for being interested in contributing to Converge. We're really happy | |||
| to have you (we have mini-parties in Slack whenever someone external opens a | |||
| PR!) | |||
| PR!). | |||
There was a problem hiding this comment.
we don't need the additional trailing periods here and in the contribution requirements
There was a problem hiding this comment.
Updated: left the period for the fragment, and removed from the complete sentences.
| We want to be sure of a few things, and testing will help us accomplish this: | ||
|
|
||
| - Help ensure a new feature or changes to an existing feature are properly | ||
| implemented. |
There was a problem hiding this comment.
adding two spaces before this line will fix code climate complaining
|
|
||
| - Include tests for the way your code interacts with the core engine. | ||
| - Test functionality of the code you have introduced, say in a new module. | ||
| - Mock interaction with the system. |
There was a problem hiding this comment.
This is not always true. In fact, I'd say we should avoid mocking when possible. Too easy to get out of sync between mocks and reality.
There was a problem hiding this comment.
This list should also include something like "tests that demonstrate a bug, and that the bug has been resolved."
There was a problem hiding this comment.
We were talking about this a bit in the office. I think we should avoid mocking whenw e can, but prefer mocking over having untested/untestable code (e.g. when the code is only available on one platform)- but we should probably have further discussion about this.
There was a problem hiding this comment.
How does this sound: "Typically, refrain from mocking and intentionally exercise the code. In few cases, mocking interaction with the system may be useful; however, avoid it if testing can be accomplished by other means."
There was a problem hiding this comment.
I think if we're going to tell people "you shouldn't mock, except when you should, but usually not" it's probably better to just not mention it at all and leave it at the fact that we should have tests for things.
|
|
||
| ##### Our Testing Goals | ||
|
|
||
| We want to be sure of a few things, and testing will help us accomplish this: |
There was a problem hiding this comment.
you can remove "help us accomplish this" and get the same meaning.
| @@ -71,7 +95,7 @@ harder to review. Pretty please? | |||
| ## Code of Conduct | |||
|
|
|||
| Participation in the development process of Converge is subject to | |||
| the [code of conduct](CODE_OF_CONDUCT.md). Please familiarise yourself with that | |||
| the [code of conduct](CODE_OF_CONDUCT.md). Please familiarize yourself with that | |||
arichardet
force-pushed
the
docs/contributing
branch
from
cb25af6
to
133dec2
Compare
Add testing section to contribution guidelines
Add information on testing and including it when contributing.