CusmaLinux / CusmaLinux/robinhoot

Create a CONTRIBUTING.md to explain how to contribute to the project

Open
#15 0 comments 0 reactions 0 assignees View on GitHub
Dominant language
TypeScript
Stars
0
Forks
0
PR merge metrics
No merged PRs in 30d

Description

### Objective
Create a CONTRIBUTING.md file

### Context
This project have a heavy architecture and uses a lot of the last features of IA agents and classic open source management, for that is necessary write the path that a dev can contribute appropriately to the project.

### Checklist
- [ ] Add a section that explain what is the software architecture of the project
- [ ] Add a section that explain how implement code with the TDD philosophy
- [ ] Add a section that explain how write docs with use cases and UML
- [ ] Add a section that explain how we are using OpenCode and what features we have integrated
- [ ] Add a section with good practices of opens ource contributions like: commits, branch names, PR context, code quality
- [ ] Add a section for a guide of code style or conventions to work with nestjs or typescript

Contributor guide

No contributing guide indexed for this repository

Research direction

Create CONTRIBUTING.md at the repository root. First inspect the project architecture, existing TypeScript/NestJS conventions, testing setup, documentation practices, and OpenCode integrations. Done means the guide covers the requested architecture, TDD, use cases and UML, OpenCode, contribution practices, and code style sections.

Written by the indexing model from the issue text.

Assessment

Tech stack
typescript
Domain
documentation
Issue type
Documentation
Difficulty
4/5
Estimated time
3-5 days
Activity status
Quiet
Clarity
Mostly clear
Newbie friendliness
55/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.