Ivan-Bangal / Ivan-Bangal/MedicalProcess_Back

Documentar a API

Open
#4 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

documentation good first issue
Dominant language
Java
Stars
0
Forks
0
PR merge metrics
No merged PRs in 30d

Description

É necessario documentar a API
Neste momento existe um documentação geral da aplicação, tem que ser documentada a API, descrevendo os metodos, serviços e repositorios

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by reviewing the existing general application documentation and locating the API entry points, methods, services, and repositories mentioned in the issue. Document the API methods and the relevant services and repositories, with coverage complete enough that the API can be understood without relying on the general application overview.

Written by the indexing model from the issue text.

Assessment

Tech stack
java
Domain
api, documentation
Issue type
Documentation
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.