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]: Add guidelines for writing tests for website components to the contributing guide #1147

Open
1 task done
kwennB opened this issue Dec 2, 2024 · 7 comments · May be fixed by #1151
Open
1 task done
Assignees
Labels
📝 Documentation Indicates improvements or additions to documentation. good first issue Good for newcomers Status: In Progress This issue is being worked on, and has someone assigned. Status: Review Needed The issue has a PR attached to it which needs to be reviewed.

Comments

@kwennB
Copy link
Contributor

kwennB commented Dec 2, 2024

What Docs changes are you proposing?

Add guidelines for testing website components to the contributing guide.

Here are some helpful resources, but they are not limited to these.

Code of Conduct

  • I agree to follow this project's Code of Conduct
@kwennB kwennB added 📝 Documentation Indicates improvements or additions to documentation. good first issue Good for newcomers Status: Triage This is the initial status for an issue that requires triage. labels Dec 2, 2024
@valeriahhdez
Copy link
Contributor

I consider this to be outside the scope of the docs-CONTRIBUTING.md guide. I suggest to document test writing inside the website's CONTRIBUTING.md guide.

@techmannih
Copy link
Contributor

@kwennB @valeriahhdez May I work on this issue

@yadavshubham01
Copy link

hey @kwennB i working on this issue can you please assign this to me

@gregsdennis
Copy link
Member

To me, this shouldn't be on the website. It needs to be in the test suite repo readme.

@gregsdennis
Copy link
Member

We're not documenting the whole of software development. The documentation on the website should only cover what JSON Schema is and how to use it.

Instructions on how to contribute to specific things should be with those specific things.

If you want to have info on how to continue to some of our projects, then it should merely link to the contributing file in those projects.

@valeriahhdez
Copy link
Contributor

valeriahhdez commented Dec 10, 2024

Summary of the triage team discussion:

  • This issue addresses the lack of guidelines for testing website components.
  • Test writing should be added to the website's CONTRIBUTING.md guide.

Based on this information, I updated the issue to better express the needs of the project.

@valeriahhdez valeriahhdez changed the title [📝 Docs]: Add a quick guide for tests writing to the contributing guide [📝 Docs]: Add guidelines for writing website components tests to the contributing guide Dec 12, 2024
@valeriahhdez valeriahhdez changed the title [📝 Docs]: Add guidelines for writing website components tests to the contributing guide [📝 Docs]: Add guidelines for writing tests for website components to the contributing guide Dec 12, 2024
@valeriahhdez valeriahhdez removed the Status: Triage This is the initial status for an issue that requires triage. label Dec 12, 2024
@harshita9104
Copy link

Hello @valeriahhdez ,

can you assign me this issue please!

Thank you

@valeriahhdez valeriahhdez moved this to In Progress in JSON Schema Docs Jan 11, 2025
@valeriahhdez valeriahhdez added the Status: In Progress This issue is being worked on, and has someone assigned. label Jan 11, 2025
@kwennB kwennB added the Status: Review Needed The issue has a PR attached to it which needs to be reviewed. label Jan 17, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
📝 Documentation Indicates improvements or additions to documentation. good first issue Good for newcomers Status: In Progress This issue is being worked on, and has someone assigned. Status: Review Needed The issue has a PR attached to it which needs to be reviewed.
Projects
Status: In Progress
6 participants