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.

Sign up for GitHub

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

Jump to bottom

Add testing guide #10

Open
1 task done
mrp089 opened this issue Dec 8, 2023 · 0 comments
Open
1 task done

Add testing guide #10

mrp089 opened this issue Dec 8, 2023 · 0 comments
Labels
documentation Improvements or additions to documentation enhancement New feature or request

Comments

@mrp089
Copy link
Member

mrp089 commented Dec 8, 2023

Problem

It would be helpful for new contributors to have a guide on how to add new tests. This should be linked in the PR template.

Solution

Add a markdown file to .github with a documentation guide. It should have the following content:

  • general philosophy
  • explanation of pytest
  • running existing tests
  • folder structure
  • adding new simulation files
  • adding new test
  • code coverage

Additional context

No response

Code of Conduct

  • I agree to follow this project's Code of Conduct and Contributing Guidelines
@mrp089 mrp089 added enhancement New feature or request documentation Improvements or additions to documentation labels Dec 8, 2023
@mrp089 mrp089 changed the title Add documentation guide Add testing guide Dec 13, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
documentation Improvements or additions to documentation enhancement New feature or request
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
1 participant
@mrp089