-
-
Notifications
You must be signed in to change notification settings - Fork 525
Add testing framework chart comparison to specific test resources #2528
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
base: main
Are you sure you want to change the base?
Conversation
|
hey , is there anything wrong with this PR? Let me know , if i could solve it. |
|
Hi @shwetchan20 you did not follow our contributor guideline process. In the future please do so appropriately by confirming the following three steps have been completed and formally requesting the issue. This will ensure that your PR is flagged in a timely manner for review.
I will review this PR early next week, but will list it as ready for review in our #website Slack channel for now. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This doesn't seem to link to the right place. I believe it's supposed to be https://github.com/Techtonica/curriculum/blob/main/testing-and-tdd/compared-testing-frameworks.md#testing-frameworks-overview?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@shwetchan20 Thank you for adding this note, however this work does NOT address the issue's instructions which as you to add another bullet in the resources (or supplemental material) sections of the lessons in the TDD folder, you have done this to one single file.
Please remove this addition from this area in this file and add its context as a bullet in the supplemental materials section of this lesson.
Furthermore, you will need to also do the same in the following lessons:
- https://github.com/Techtonica/curriculum/blob/main/testing-and-tdd/enzyme-testing.md#supplemental-resource
- https://github.com/Techtonica/curriculum/blob/main/testing-and-tdd/integration-testing.md#supplemental-materials
- https://github.com/Techtonica/curriculum/blob/main/testing-and-tdd/jasmine-testing.md#supplemental-materials
- https://github.com/Techtonica/curriculum/blob/main/testing-and-tdd/jest.md#supplemental-materials
- https://github.com/Techtonica/curriculum/blob/main/testing-and-tdd/mocking-and-abstraction.md#supplemental-materials
- https://github.com/Techtonica/curriculum/blob/main/testing-and-tdd/react-testing-jest-and-RTL.md (this lesson does not have a "Supplemental Resources" section you will need to add it following the header convention of other lessons)
- https://github.com/Techtonica/curriculum/blob/main/testing-and-tdd/testing-and-tdd.md#supplemental-materials
- https://github.com/Techtonica/curriculum/blob/main/testing-and-tdd/testing-mindset.md#supplemental-materials
- https://github.com/Techtonica/curriculum/blob/main/testing-and-tdd/vitest.md#supplemental-materials
| @@ -1,4 +1,5 @@ | |||
| # Adding Chai/Mocha Tests to your project | |||
| > **Note:** For an overview of how this framework compares to others, see the [General Testing Framework Comparison Chart](testing-and-tdd.md). | |||
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The link should lead to this chart, please update the link.
| > **Note:** For an overview of how this framework compares to others, see the [General Testing Framework Comparison Chart](testing-and-tdd.md). | |
| > **Note:** For an overview of how this framework compares to others, see the [General Testing Framework Comparison Chart]([/testing-and-tdd/compared-testing-frameworks.md#testing-frameworks-overview](https://github.com/Techtonica/curriculum/blob/main/testing-and-tdd/compared-testing-frameworks.md#testing-frameworks-overview)). |
This PR improves the Testing & TDD lessons by adding references to the general testing framework comparison chart.
Added a note at the top of Jest.md and Chai.md linking to General Testing Framework Comparison Chart
Helps participants understand how each framework relates to others
Enhances curriculum clarity and cross-referencing for learners new to testing frameworks
🔂 Changes Made
Updated Jest.md and Chai.md to include a link to the general testing framework comparison chart.
No code changes; only documentation/markdown edits.
⚙️ Related Issue
Issue Number: #2379
🍏 Type of Change
Bug fix
New feature
Refactoring
Documentation update
Topic Outline
🎁 Acceptance Criteria
The note is correctly added at the top of both Jest.md and Chai.md
The link points to testing-and-tdd.md and works properly on GitHub
No formatting or markdown errors introduced
🧪 How to test or what to evaluate
Open Jest.md and Chai.md in GitHub preview.
Verify the note is at the top of each file.
Click the link and confirm it navigates correctly to testing-and-tdd.md.
🚀 Repo Notes (if applicable)
No updates to the table of contents required.
Only impacts Testing & TDD lessons.
No changes to full-time program curriculum.
📸 Screenshots (if applicable)
Not applicable; documentation-only change.
✅ Checklist
I have performed a self-review of my code.
My code follows the style guidelines of this project.
I have commented my code where necessary.
I have tested my code locally and verified the website is working as expected.
(if applicable) I have added documentation in the README.
(if applicable) I have added tests that prove my fix is effective or that my feature works.
(if applicable) New and existing unit tests pass locally with my changes.