Hacktoberfest 2026: as issues que os mantenedores marcaram para outubro, abertas e boas para iniciantes. Ver issues do Hacktoberfest

Docs on the CLI or the JS API?

Aberta
#348 0 comentários 3 reações 0 responsáveis Ver no GitHub

Mantenedores costumam responder em até 1 dia

Ninguém assumiu esta issue ainda.

Avaliação

Dificuldade
5/5
Tempo estimado
Mais de uma semana
Facilidade para iniciantes
25/100
Tipo de issue
Documentação
Clareza
Precisa de esclarecimento
Status de atividade
Estagnada
Stack de tecnologia
javascript
Domínio
api, cli, documentation

Direção de pesquisa

A issue nomeia CLI, JS API e JSDocs como pontos de entrada a serem investigados; comece verificando se existe documentação voltada ao público para cada um deles. Para considerar o trabalho concluído, seria necessário um escopo de documentação ou processo de geração acordado que cubra as interfaces solicitadas sem adicionar uma carga de manutenção pouco clara.

Escrita pelo modelo de indexação a partir do texto da issue.

Descrição

Hi there! I just stumbled upon this library recently and it looks excellent — are there any public-facing docs on the CLI or the JS API?

If you're accepting external contributors for documentation, let me know. I'd be happy to at least help set up some sort of doc generation process (e.g., based on the JSDocs) — I want to be mindful of not adding on to the maintenance burden 🙂 thanks!

Linguagem predominante
C#
Estrelas
290
Forks
50
Merge médio
7h 8min
PRs com merge (30d)
11

Preparar o ambiente

Primeiros passos

  1. Leia a issue inteira e depois o guia de contribuição do projeto.
  2. Comente na issue dizendo que vai assumir — evita que duas pessoas façam o mesmo trabalho.
  3. Faça um fork do repositório e trabalhe em uma branch.
  4. Abra um pull request que referencie o número da issue.

Mais de Azure/openapi-diff

Todas as issues de Azure/openapi-diff

Issues semelhantes

Mais issues de C#

Receba novas issues na sua caixa de entrada

Um resumo curto de issues do GitHub para quem está começando.