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 documentation on how to add new tests #12

Merged
merged 5 commits into from
May 13, 2024
Merged

Add documentation on how to add new tests #12

merged 5 commits into from
May 13, 2024

Conversation

m-aXimilian
Copy link
Contributor

Description

Adds a section to the building.md explaining how new tests (with accompanying data) can be added.

Type of change

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to not work as expected)
  • This change requires a documentation update

How Has This Been Tested?

This is a documentation-only PR -> No tests needed.

Checklist:

  • I followed the Contributing Guidelines.
  • I did a self-review.
  • I commented my code, particularly in hard-to-understand areas.
  • I updated the documentation.
  • I have added tests that prove my fix is effective or that my feature works.
  • New and existing unit tests pass locally with my changes.

@ptahmose ptahmose added the cla Contributor License Agreement sent to Admin label May 13, 2024
@ptahmose ptahmose marked this pull request as ready for review May 13, 2024 09:26
ptahmose
ptahmose previously approved these changes May 13, 2024
View reviewed changes
Copy link
Contributor

@ptahmose ptahmose left a comment

Choose a reason for hiding this comment

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

LGTM, thanks

@m-aXimilian m-aXimilian requested a review from ptahmose May 13, 2024 09:30
ptahmose
ptahmose approved these changes May 13, 2024
View reviewed changes
Copy link
Contributor

@ptahmose ptahmose left a comment

Choose a reason for hiding this comment

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

LGTM, thanks

@m-aXimilian m-aXimilian merged commit 0d6cd0f into main May 13, 2024
7 checks passed
@m-aXimilian m-aXimilian deleted the m-aximilian/enhance-test-documentation branch May 13, 2024 09:41
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@ptahmose ptahmose ptahmose approved these changes

Assignees
No one assigned
Labels
cla Contributor License Agreement sent to Admin
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@m-aXimilian @ptahmose