space-wizards / space-wizards/docs
There should be documentation on how to run tests
Nobody has claimed this yet.
- Dominant language
- CSS
- Stars
- 42
- Forks
- 304
- PR merge metrics
- No merged PRs in 30d
Description
It's not obvious to most new contributors that you have to run both Content.Tests, Content.IntegrationTests and Content.YAMLLinter to properly test your changes.
There should be a section under "General Development" explaining how to run Tests/IntegrationTests/Linter, both for content and engine. It could also explain how to only run a specific test, using the --filter option.
Contributor guide
No contributing guide indexed for this repository
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start with the documentation's “General Development” section and review how Content.Tests, Content.IntegrationTests, and Content.YAMLLinter are currently run for content and engine. Document the commands, including how to target one test with --filter; the work is done when new contributors can find and follow complete test and linter instructions.
Written by the indexing model from the issue text.
Assessment
- Domain
- documentation, testing
- Issue type
- Documentation
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 38/100