oppia / oppia/oppia-web-developer-docs

Document a "starter workflow" for devs to test that they have a fully-working dev env.

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

Nobody has claimed this yet.

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

Description

Provide a "developer readiness/starter kit" wiki page that gives developers a checklist to verify that they have a fully-working dev env for Oppia Web. Things to check:

  • Start the local dev server in reasonable time.
  • Make changes to the code, and have those changes show up on the local server almost immediately, without them having to restart it.
  • View backend + frontend logs and stack traces when running the dev server.
  • Run individual tests on the local machine in reasonable time. Verify this for: backend tests, frontend tests, e2e tests, acceptance tests, typescript checks, mypy checks. (Consider asking them to report if the time needed to run a single test in each of these categories is greater than some threshold.)
  • View errors / stack traces when tests fail. To check this, introduce an error in the code, and make sure they can see the resulting console.log() (or equivalent) statements. Do this for each of the backend, frontend, e2e and acceptance tests.

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

Create the developer readiness/starter kit wiki page in the Oppia Web developer documentation repository. Organize checks for server startup, live code changes, logs, individual backend, frontend, e2e, acceptance, TypeScript, and mypy tests, including failure stack traces; done means a developer can verify each item locally and report slow test times.

Written by the indexing model from the issue text.

Assessment

Tech stack
python, typescript
Domain
documentation, testing
Issue type
Documentation
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.