Como reportar issues, propor funcionalidades e submeter Pull Requests para o projeto IGRP.
Obrigado por pensares em contribuir para o IGRP! Este guia explica como participar de forma eficaz.
Código de conduta
Ao participar neste projeto, concordas em cumprir o nosso Código de conduta. Por favor lê-o antes de contribuires.
Colocar dúvidas
Antes de abrir uma issue, verifica se a tua dúvida já foi respondida:
- Consulta a documentação
- Pesquisa nas issues do repositório no GitHub
- Contacta a equipa em igrp@nosi.cv ou no Discord
Reportar um bug
Ao reportar um bug, inclui sempre:
- Versão do IGRP Studio
- Sistema operativo e versão
- Passos para reproduzir o problema
- Comportamento esperado vs. comportamento observado
- Logs relevantes ou screenshots
Propor uma funcionalidade
Para propor uma nova funcionalidade:
- Verifica se já existe uma issue semelhante
- Descreve o problema que resolve
- Explica a solução proposta
- Considera alternativas que tenhas ponderado
Onde reportar
| Canal | Para quê |
|---|---|
| Issues no GitHub | Bugs e pedidos de funcionalidade, no repositório do módulo — ver Código-fonte |
| E-mail — igrp@nosi.cv | Bugs, pedidos e módulos que ainda não têm repositório público |
| Discord — discord.gg/dywFBFaCQr | Bugs e dúvidas rápidas, em conversa com a equipa |
Vulnerabilidades de segurança nunca em issues públicas nem no Discord — ver Política de segurança.
Submeter pull requests
O código está no GitHub, na organização NOSiCode-CV, um repositório por módulo (lista em Código-fonte).
- Faz fork do repositório do módulo
- Cria o teu branch a partir do branch por omissão (
github-release):feature/<nome>,fix/<nome>ourefactor/<nome> - Faz as alterações com testes
- Corre os testes do módulo:
mvn test(backend) ou o script de testes dopackage.json(frontend) - Abre o pull request contra o branch por omissão, a descrever o problema e a solução
A equipa revê o pull request e integra a alteração nas versões seguintes.
Convenções de commit
Seguimos o Conventional Commits:
| Prefixo | Uso |
|---|---|
feat: | Nova funcionalidade |
fix: | Correção de bug |
docs: | Alterações na documentação |
chore: | Tarefas de manutenção (build, deps) |
refactor: | Refatoração sem mudança de comportamento |
test: | Adição ou correção de testes |
Exemplos:
feat(access-management): add M2M client credential flow
fix(nextjs-engine): emit static select options
docs(process): document the TypeScript SDKsEscrever documentação
As páginas desta documentação são MDX e usam apenas Markdown e os componentes da documentação — sem HTML/CSS próprio. Os diagramas de arquitetura usam o kit de diagramas (src/components/diagrams), nunca imagens com cores fixas. Consulta essa página para ver cada componente com exemplo de uso.
Última atualização: