commercetest / commercetest/nlnet

Add Testing Documentation to the Project

Open
#92 0 comments 0 reactions 1 assignee Claimed by @tnzmnjm View on GitHub
Dominant language
Python
Stars
1
Forks
0
PR merge metrics
No merged PRs in 30d

Description

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`

Contributor guide

No contributing guide indexed for this repository

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.