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

326 - Developer guide - Writing test cases #349

Conversation

MellyGray
Copy link
Contributor

What this PR does / why we need it:

This PR adds the Writing tests cases section to the Developer Guide.

Which issue(s) this PR closes:

Special notes for your reviewer:

Suggestions on how to test this:

Check the new section in the README

Does this PR introduce a user interface change? If mockups are available, please link/include them here:

No

Is there a release notes update needed for this change?:

Writing tests cases section added to the Developer Guide

Additional documentation:

@MellyGray MellyGray added Size: 3 A percentage of a sprint. 2.1 hours. pm.GREI-d-2.7.1 NIH, yr2, aim7, task1: R&D UI modules for creating datasets and supporting publishing workflows pm.GREI-d-2.7.2 NIH, yr2, aim7, task2: Implement UI modules for creating datasets and publishing workflows SPA: Documentation Milestone tag for all SPA-related documenting tasks labels Mar 19, 2024
@MellyGray MellyGray changed the base branch from develop to docs/26-add-frontend-guides March 19, 2024 10:09
@MellyGray MellyGray marked this pull request as ready for review March 19, 2024 10:10
@coveralls
Copy link

coveralls commented Mar 19, 2024

Coverage Status

coverage: 97.425%. remained the same
when pulling 6d2c130 on docs-326-developer-guide-writing-test-cases
into ae5db42 on docs/26-add-frontend-guides.

@g-saracca g-saracca self-assigned this Mar 19, 2024
Copy link
Contributor

@g-saracca g-saracca left a comment

Choose a reason for hiding this comment

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

Looks great, just leaving a comment but nothing that needs to be done to approve this pr!

> 2. Select `Generate new token (classic)`
> 3. Give the token a name and select scope `read:packages`
> 4. Copy the generated token and replace the string `YOUR_GITHUB_AUTH_TOKEN` in the previously created `.npmrc` file.
> Now, you should be able to install the [Dataverse JavaScript][dv_repo_dvclientjs_url] client using npm.

Afterwards, your .npmrc file should resemble the following:
Copy link
Contributor

Choose a reason for hiding this comment

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

Should we add a note? saying that the .npmrc file is still not identical as .npmrc.example, but because we will cover that later in the readme ( I think you already cover that in the design system deployment readme right?)
Or it will be too mucht text?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

That makes sense, I'll move your comment to this other PR because this is not related with the Writing test cases section

I've opened a separate pull request where we can review Matthew's changes to the README

Copy link
Member

@pdurbin pdurbin left a comment

Choose a reason for hiding this comment

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

All the new testing stuff looks great. I did leave a comment or two.

@@ -1,4 +1,3 @@

# Looking for support? We want to help

Please post your question to X (#) using the Timber tag.
Copy link
Member

Choose a reason for hiding this comment

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

Timber tag? What is this? 🤔

Copy link
Contributor Author

Choose a reason for hiding this comment

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

I'm not sure about the 'Timber' tag; I believe it was added by Matthew. I've opened a separate pull request where we can review Matthew's changes to the README

Copy link
Member

Choose a reason for hiding this comment

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

Thanks, I just added a review to this SUPPORT.md file, at least! 😅

README.md Outdated
### 1. **Unit Tests or Component tests:**

Unit tests are designed to test individual React components in isolation. In our approach, we focus on testing components
from the user's perspective, following the principles of the Testing Library. This means:
Copy link
Member

Choose a reason for hiding this comment

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

Suggested change
from the user's perspective, following the principles of the Testing Library. This means:
from the user's perspective, following the principles of the React Testing Library. This means:

Also, maybe move the link to React Testing Library here (from below).

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Thank you for the suggestion! I have moved the link and updated the text accordingly

})
})
```

Copy link
Member

Choose a reason for hiding this comment

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

Is there a missing </details> here? When I look at the page at https://github.com/IQSS/dataverse-frontend/blob/1220a7d865f3a0031e8fa8449265855f28e5200c/README.md it seems to end at "Wait for no locks":

Screenshot 2024-03-21 at 3 10 23 PM

If I expand it, I see more content, unrelated to locks. The rest of the page, basically.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

You're right! I added the missing closing tag

@MellyGray MellyGray self-assigned this Mar 25, 2024
@MellyGray MellyGray removed their assignment Mar 25, 2024
@ekraffmiller ekraffmiller self-assigned this Mar 28, 2024
@ekraffmiller
Copy link
Contributor

looks good! The e2e test is failing, but I think that is due to base branch, docs/26-add-frontend-guides being behind develop.

@ekraffmiller ekraffmiller merged commit 98ba0bb into docs/26-add-frontend-guides Mar 28, 2024
10 of 14 checks passed
@MellyGray MellyGray deleted the docs-326-developer-guide-writing-test-cases branch April 4, 2024 13:30
jayanthkomarraju pushed a commit to jayanthkomarraju/dataverse-frontend that referenced this pull request May 31, 2024
…g-test-cases

326 - Developer guide - Writing test cases
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
pm.GREI-d-2.7.1 NIH, yr2, aim7, task1: R&D UI modules for creating datasets and supporting publishing workflows pm.GREI-d-2.7.2 NIH, yr2, aim7, task2: Implement UI modules for creating datasets and publishing workflows Size: 3 A percentage of a sprint. 2.1 hours. SPA: Documentation Milestone tag for all SPA-related documenting tasks
Projects
None yet
Development

Successfully merging this pull request may close these issues.

[Spike - Developer Guide] Writing test cases
5 participants