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

Update contribution.md #1396

Closed
wants to merge 2 commits into from
Closed

Update contribution.md #1396

wants to merge 2 commits into from

Conversation

colin-stubbs
Copy link
Contributor

Add guidance on module testing and possible warning/error/critical level outputs that may be seen.

@TheTechromancer
Copy link
Collaborator

TheTechromancer commented May 23, 2024

Thanks for undertaking this @colin-stubbs. I appreciate the effort and attention to the documentation. A rewrite of the contribution section is forthcoming for BBOT 2.0:

  • Full start-to-finish tutorial on how to write a module (including writing/debugging tests)

I can't accept this yet but once I start the rewrite I will have a better idea of where this will fit. It's given me some good ideas and I think I'd like there to be a module-writing tutorial that includes how to write a module test, and then a separate, more in-depth section similar to what you have here.

@TheTechromancer TheTechromancer added documentation Improvements or additions to documentation on hold labels May 23, 2024
@colin-stubbs
Copy link
Contributor Author

@TheTechromancer no worries.

p.s. something about how to test individual modules would be worth adding... with 15-20 minutes per full run simple quick and dirty testing of individual modules is is definitely necessary to speed up module creation.

e.g. I'm now just doing this in order to skip past everything else,

export bbot_dir=`pwd`/bbot
pytest --exitfirst --disable-warnings --log-cli-level=ERROR "$bbot_dir" --cov=bbot/test/test_step_2/test_cli.py --cov-report="term-missing" --cov-config="$bbot_dir/test/coverage.cfg" -k newmodulename

@colin-stubbs colin-stubbs closed this by deleting the head repository Aug 3, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation on hold
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants