Skip to content

How to test contributions #553

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

Open
wants to merge 14 commits into
base: master
Choose a base branch
from
Open

How to test contributions #553

wants to merge 14 commits into from

Conversation

Stockless
Copy link
Collaborator

@Stockless Stockless commented Mar 24, 2025

Added the section "How to test contributions" in the "How to contribute to Koma" documentation. this PR sovles the issue #552

Here is the preview.

@cncastillo
Copy link
Member

cncastillo commented Mar 24, 2025

I think the instructions are too verbose. The instruction for KomaMRI, KomaMRIBase, KomaMRIFiles and KomaMRIPlots are pretty much identical. The only one that is different is KomaMRICore. Did this use ChatGPT?

If the user generates a new function that is not currently tested the Code Coverage will decrease. This will be reported in the same PR. It would be great to add instructions to add tests.

Furthermore, if KomaMRI is tested like that in VSCode it will fail. As the UI will not open correctly.

@Stockless
Copy link
Collaborator Author

Stockless commented Mar 27, 2025

I think the instructions are too verbose. The instruction for KomaMRI, KomaMRIBase, KomaMRIFiles and KomaMRIPlots are pretty much identical. The only one that is different is KomaMRICore. Did this use ChatGPT?

I only used ChatGPT to check the redaction, but I wrote it down. most of the KomaMRICore text is directly from its note in the runtest.jl. This was covered in commit 31050a1

@Stockless
Copy link
Collaborator Author

If the user generates a new function that is not currently tested the Code Coverage will decrease. This will be reported in the same PR. It would be great to add instructions to add tests.

Could you please give me an example to understand it and add it to the documentation?

@Stockless
Copy link
Collaborator Author

Furthermore, if KomaMRI is tested like that in VSCode it will fail. As the UI will not open correctly.

This was solved in commit 31050a1

@cncastillo
Copy link
Member

This is an example on how the code diverse looks

#537 (comment)

@Stockless
Copy link
Collaborator Author

If the user generates a new function that is not currently tested the Code Coverage will decrease. This will be reported in the same PR. It would be great to add instructions to add tests.

Created the instructions in this commit 8ac276e

@cncastillo
Copy link
Member

@Stockless where can i see a preview?

@Stockless
Copy link
Collaborator Author

@Stockless where can i see a preview?

I have created a local preview with Live Server in VSCode to verify the correct compilation of the documentation. This are some screenshots of the latest corrections implemented 9edc5fa:
image
image

@cncastillo
Copy link
Member

I meant a docs preview. A website I can click, like done in other PRs.

@Stockless Stockless added the documentation Improvements to docs., it also triggers doc preview label Jun 9, 2025
@Stockless
Copy link
Collaborator Author

I meant a docs preview. A website I can click, like done in other PRs.

I understand now. Here is the preview.

@cncastillo
Copy link
Member

I don't think you completely got my comments, so I put them as a GDocs

https://docs.google.com/document/d/1X8Wy81SwumONU4357gz56BNcKM-QLTKVJfP3ew_ly2E/edit?usp=sharing

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements to docs., it also triggers doc preview maintenance
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants