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

docs: add new documentation related to testing style guide and testing template #12083

Merged
merged 13 commits into from May 22, 2024

Conversation

EshaanAgg
Copy link
Contributor

Summary

Adds

  • Style guide for testing
  • A test template and common ways to use the mocks

References

Slack Discussion

Reviewer guidance


Testing checklist

  • Contributor has fully tested the PR manually
  • If there are any front-end changes, before/after screenshots are included
  • Critical user journeys are covered by Gherkin stories
  • Critical and brittle code paths are covered by unit tests

PR process

  • PR has the correct target branch and milestone
  • PR has 'needs review' or 'work-in-progress' label
  • If PR is ready for review, a reviewer has been added. (Don't use 'Assignees')
  • If this is an important user-facing change, PR or related issue has a 'changelog' label
  • If this includes an internal dependency change, a link to the diff is provided

Reviewer checklist

  • Automated test coverage is satisfactory
  • PR is fully functional
  • PR has been tested for accessibility regressions
  • External dependency files were updated if necessary (yarn and pip)
  • Documentation is updated
  • Contributor is in AUTHORS.md

@MisRob MisRob added the TODO: needs review Waiting for review label Apr 15, 2024
Copy link
Member

@AlexVelezLl AlexVelezLl left a comment

Choose a reason for hiding this comment

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

Thanks for all your work here @EshaanAgg! This is looking great, these are some thoughts from an initial reading. But it's definitely looking good.

docs/frontend_architecture/unit_testing.rst Outdated Show resolved Hide resolved
docs/frontend_architecture/unit_testing.rst Outdated Show resolved Hide resolved
docs/frontend_architecture/unit_testing.rst Outdated Show resolved Hide resolved
docs/frontend_architecture/unit_testing.rst Outdated Show resolved Hide resolved
docs/frontend_architecture/unit_testing.rst Outdated Show resolved Hide resolved
docs/frontend_architecture/unit_testing.rst Show resolved Hide resolved
docs/frontend_architecture/unit_testing.rst Outdated Show resolved Hide resolved
docs/frontend_architecture/unit_testing.rst Outdated Show resolved Hide resolved
docs/frontend_architecture/index.rst Outdated Show resolved Hide resolved
docs/frontend_architecture/testing_layout.rst Outdated Show resolved Hide resolved
@EshaanAgg
Copy link
Contributor Author

Thanks, @MisRob and @AlexVelezLl, for all the help. I have updated the documentation as per the review comments. I also took the liberty to make two more changes:

Let me know if you would like to see something else added!

@MisRob MisRob requested a review from AlexVelezLl April 25, 2024 03:37
Copy link
Member

@AlexVelezLl AlexVelezLl left a comment

Choose a reason for hiding this comment

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

Hi @EshaanAgg! Thank you for all your great work here. Sorry for the delay in the review. And Sorry for the back and forth. I think this will be the last before approval from my side. It's pretty polished already 🎉.

docs/frontend_architecture/unit_testing.rst Outdated Show resolved Hide resolved
docs/frontend_architecture/unit_testing.rst Outdated Show resolved Hide resolved
docs/frontend_architecture/unit_testing.rst Show resolved Hide resolved
docs/frontend_architecture/unit_testing.rst Show resolved Hide resolved
docs/frontend_architecture/testing_layout.rst Outdated Show resolved Hide resolved
docs/frontend_architecture/testing_layout.rst Show resolved Hide resolved
@AlexVelezLl AlexVelezLl self-assigned this May 16, 2024
Copy link
Member

@AlexVelezLl AlexVelezLl left a comment

Choose a reason for hiding this comment

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

Thanks for all your hard work here @EshaanAgg!! 🎉. In the future we could edit the documentation and cover some point that we might be missing, but for now it looks pretty good. The style guide shows the what and how quite well. The testing template looks quite good and complete for multiple cases, and the structure in general seems adequate and easy to follow!! LGTM! Thank you 🚀🚀🚀.

@AlexVelezLl AlexVelezLl merged commit 913035a into learningequality:develop May 22, 2024
31 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

4 participants