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: update debugging & tips text #270

Open
wants to merge 1 commit into
base: gh-pages
Choose a base branch
from
Open

Conversation

dcoleman21
Copy link
Contributor

Backend Curriculum PR Template

Description

This PR updates the Iteration 1 documentation under debugging & tips to inform students what to expect when running the tests and how they should proceed.

Provide a brief summary of the change(s) included in this pull request

  • Updates debugging section in Iteration 1 to be more explicit for what student expectations are.
  • Updates tips section in Iteration 1 to be more explicit for what the student expectations are.

Why are we making this update?

  • Ensure students have clear directions for what they need to do.

Share the reason(s) for this pull request

Type of update

  • Minor update/fix -- no review requested
  • Moderate update -- review from Mod Team requested
  • Major update -- review from Backend Team requested

How will we measure the success of this change?

Share any hypothesized outcomes we might observe

What questions do you have/what do you want feedback on? (optional)

List any specific questions and feedback requests

@dcoleman21 dcoleman21 requested a review from megstang May 18, 2023 15:33
@@ -15,12 +15,13 @@ You should explore:
* Take note of the project folder structure. Is there anything you haven't seen before?

### Debugging
If you haven't already, run the tests now. You should see some failing tests. Work through fixing the code until the tests pass. You only change the application code, not the tests. It might be helpful to run each test one at a time and fix one by one.
If you haven't already, run the tests now. You should see some failing tests. Work through fixing the code until the tests pass. You will only change the application code in `spec/dmv_spec.rb`, not the tests. You will make updates to the tests in `spec/dmv_data_service_spec.rb`, not the application code. It might be helpful to run each test one at a time and fix one by one.
Copy link
Contributor

Choose a reason for hiding this comment

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

"You will only change the application code in spec/dmv_spec.rb, not the tests." is a bit contradictory. dmv_spec is a test, not application code.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants