Update testing guidelines, add dev container badge #4551
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
* Add links to wiki * Add extra test guidelines and helpful classes when writing tests * Add notes on running tests with Event Sourcing * Add notes on continuous integration * Remove reference to bundle exec rake (it only runs default task which is spec)
* Codespaces uses Dev Containers so supporting Codespaces is the same as supporting Dev Containers locally
dorner
previously requested changes
Jul 26, 2024
| #### Guidelines | ||
| - When creating factories, in each RSpec test, hard code all values that you check with a RSpec matcher. Don't check FactoryBot default values. See [#4217](https://github.com/rubyforgood/human-essentials/issues/4217) for why. | ||
| - Write tests to pass with Event Sourcing turned both on and off, see the [Event Sourcing wiki page](https://github.com/rubyforgood/human-essentials/wiki/Event-Sourcing). | ||
| - Keep individual tests tightly scoped, only test the endpoint that you want to test. E.g. create inventory directly using `TestInventory` rather than using an additional endpoint. |
There was a problem hiding this comment.
Can we add a line about not adding system tests unless we actually need to test interactivity (e.g. JavaScript) and preferring request tests instead?
There was a problem hiding this comment.
resolved in b5e13e5
also added wiki contribution workflow and fixed dev container instructions
* Add reminder to add remote after opening dev container * Add test guideline to prefer request specs * Add wiki contribution workflow
awwaiid
approved these changes
Aug 4, 2024
awwaiid
dismissed
dorner’s stale review
Changes applied, so closing this change-request
|
@jimmyli97: Your PR |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Together with #4550 updates documentation to include useful test classes and guidelines
Description
Adds information to make it easier for new contributors to contribute and write tests:
Type of change
How Has This Been Tested?
Clicked Dev Container badge and opened dev container in VS Code on my local machine