Skip to content

Add proper README and DEVELOPER_GUIDE #16

@kneerose

Description

@kneerose
  • The current repository lacks a comprehensive README.md and DEVELOPER_GUIDE.md. A well-documented README and a structured guide will help new contributors understand the project structure, setup instructions, and contribution process.

Aceptance Criteria

  • Create a well-structured README.md that includes
    • Setup instructions
    • running the test
    • Visualization Allure Report
  • Add a DEVELOPER_GUIDE.md (or section within the README) that includes:
    • folder structure and it uses

Metadata

Metadata

Assignees

Labels

documentationImprovements or additions to documentation

Type

No type
No fields configured for issues without a type.

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions