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

Add Testing Documentation to the Project #92

Open
5 tasks
tnzmnjm opened this issue Dec 12, 2024 · 0 comments
Open
5 tasks

Add Testing Documentation to the Project #92

tnzmnjm opened this issue Dec 12, 2024 · 0 comments

Comments

@tnzmnjm
Copy link
Collaborator

tnzmnjm commented Dec 12, 2024

Description:

The purpose of this issue is to prepare a comprehensive testing documentation file to guide contributors in writing, organising, and running tests consistently. The document should include testing principles, test types, writing guidelines, and CI integration practices.

Tasks:

  • Create a new file TESTING.md in the project root.

  • Add sections for:

  • Testing Principles

  • Test Types (Unit, Integration, Edge Case, Regression)

  • Writing Tests (Structure and Checklist)

  • Running Tests

  • Tools and Frameworks

  • Continuous Integration

  • Verify all instructions are accurate and applicable to the project.

  • Add example configurations for CI and test coverage.

  • Submit the document for review.

References:

  • Refer to the draft document prepared in the TESTING.md
tnzmnjm pushed a commit that referenced this issue Dec 12, 2024
- Created `TESTING.md` to outline guidelines for writing, organising, and running tests.
- Included sections on testing principles, test types, writing tests, tools, and CI integration.
- Added example configurations for GitHub Actions and test coverage thresholds.

This is related to the issue #92
tnzmnjm pushed a commit that referenced this issue Dec 12, 2024
…t testing practices.

This is related to the issue #92
tnzmnjm pushed a commit that referenced this issue Dec 12, 2024
- Added a section for testing to ensure contributors document added tests and test coverage.
- Added a reference to the `TESTING.md` file in the Testing section of the template.
- Updated the checklist to include:
  - Confirmation of tests for new functionality.
  - Verification that existing tests pass without modifications.

This is related to the issue #92
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

When branches are created from issues, their pull requests are automatically linked.

1 participant