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 test documentation with examples #1630

Merged
merged 4 commits into from
Apr 4, 2022
Merged

Conversation

minhhoang1023
Copy link
Contributor

@minhhoang1023 minhhoang1023 commented Apr 4, 2022

This PR updates the existing documentation by including examples on how to build test. This is so that users can easily replicate, and hence reduce the barrier to contributing. Some guidelines on how to fix failed existing tests also included

Instructions were provided for:

  • View test
  • Model test
  • Controller test

Big thanks to @Chavithra for the help

Description

  • Summary of the change / bug fix.
  • Link # issue, if applicable.
  • Screenshot of the feature or the bug before/after fix, if applicable.
  • Relevant motivation and context.
  • List any dependencies that are required for this change.

How has this been tested?

  • Please describe the tests that you ran to verify your changes.
  • Provide instructions so we can reproduce.
  • Please also list any relevant details for your test configuration.

Checklist:

Others

  • I have performed a self-review of my own code.
  • I have commented my code, particularly in hard-to-understand areas.
  • My code passes all the checks pylint, flake8, black, ... To speed up development you should run pre-commit install.
  • New and existing unit tests pass locally with my changes. You can test this locally using pytest tests/....

@minhhoang1023 minhhoang1023 added the docs Code documentation label Apr 4, 2022
Copy link
Contributor

@Chavithra Chavithra left a comment

Choose a reason for hiding this comment

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

That's great.

Thanks Minh !

@piiq piiq merged commit b4e44d2 into main Apr 4, 2022
@piiq piiq deleted the test-documentation-examples branch April 4, 2022 19:15
mrriteshranjan added a commit to mrriteshranjan/OpenBBTerminal that referenced this pull request Apr 6, 2022
mrriteshranjan added a commit to mrriteshranjan/OpenBBTerminal that referenced this pull request Apr 7, 2022
mrriteshranjan added a commit to mrriteshranjan/OpenBBTerminal that referenced this pull request Apr 7, 2022
mrriteshranjan added a commit to mrriteshranjan/OpenBBTerminal that referenced this pull request Apr 12, 2022
mrriteshranjan added a commit to mrriteshranjan/OpenBBTerminal that referenced this pull request Apr 12, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
docs Code documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants