Change and check
Lesson 2 of 3 in Ship a first pull request. About 20 minutes.
In this lesson you make the change, run the checks and save your work.
Steps
-
Make the change. One concern per pull request. If your change alters a command, a setting, a route or a setup step, edit the docs page that states it in the same pull request.
-
Run the checks for the part you touched.
-
You changed
backend/:Terminal window dotnet test tests/TextStack.UnitTestsdotnet format textstack.sln --verify-no-changes -
You changed
apps/web/:Terminal window pnpm -C apps/web testpnpm -C apps/web build -
You changed
apps/admin/:Terminal window pnpm -C apps/admin build -
You changed
apps/mobile/:Terminal window pnpm --filter mobile typecheck -
You changed
docs/or any.mdfile:Terminal window node scripts/check-doc-links.mjs
You should see: every command ends without errors. The backend unit tests print
Passed!with zero failed. -
-
Commit. One logical change per commit. The first line is
type(scope): summary. The types arefeat,fix,refactor,docsandtest.Terminal window git add -Agit commit -m "fix(reader): keep the position after a font change"
If something goes wrong
dotnet formatreports changes. Rundotnet format textstack.slnwithout--verify-no-changes, then commit the result.dotnet testwith no project name fails with connection errors. It also runs the integration tests, which need the running backend. Run the unit test project only. CI runs the rest.
Check yourself
- My change does one thing.
- The checks for my part ended without errors.
- My work is committed.