oppia / oppia/oppia-web-developer-docs

Create Tutorial - How to write backend unit tests.

Open
#381 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

enhancement Impact: Medium Work: Medium
Dominant language
Python
Stars
18
Forks
133
PR merge metrics
No merged PRs in 30d

Description

Skills covered

Python, Writing unit tests to cover all the known corner cases, Running unit tests.

Similar issues

Existing relevant pages

https://github.com/oppia/oppia/wiki/Backend-tests

Example

Write a git patch file to remove some of the existing tests of profile_test file.

Scenario: You have just written code for a profile_test file and now you need to write unit tests to cover your code. Understand the code first, try to think of general cases and then corner cases. Make sure it follows best practices and test it by running them in your local machine.

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by reading the existing Backend-tests wiki page and the profile_test example described in the issue. Draft a tutorial covering Python backend unit tests, general and corner cases, best practices, and local test execution. Done means the tutorial is added to the documentation repository with the requested skills and example clearly explained.

Written by the indexing model from the issue text.

Assessment

Tech stack
python
Domain
documentation
Issue type
Documentation
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
45/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.