open-im-server/docs/README_pt_BR.md

Documentação do Servidor OpenIM

Bem-vindo ao centro de documentação do OpenIM! Este centro oferece uma ampla gama de guias e manuais projetados para ajudá-lo a aproveitar ao máximo sua experiência com o OpenIM.

Índice de Conteúdos

1. Contrib - Orientações sobre contribuições e configurações para desenvolvedores
2. Conversions - Convenções de codificação, políticas de registro e outras ferramentas de transformação

---

Contrib

Esta seção oferece aos desenvolvedores um guia detalhado sobre como contribuir com código, configurar seu ambiente e seguir os processos associados.

• Code Conventions - Regras e convenções para escrever código no OpenIM.
• Development Guide - Um guia sobre como realizar o desenvolvimento dentro do OpenIM.
• Git Cherry Pick - Diretrizes sobre operações de cherry-picking.
• Git Workflow - O fluxo de trabalho git no OpenIM.
• Initialization Configurations - Orientações sobre configuração e inicialização do OpenIM.
• Docker Installation - Como instalar o Docker em sua máquina.
• Linux Development Environment - Guia para configurar o ambiente de desenvolvimento no Linux.
• Local Actions - Diretrizes sobre como realizar certas ações comuns localmente.
• Offline Deployment - Métodos para implantar o OpenIM offline.
• Protoc Tools - Guia sobre o uso de ferramentas protoc.
• Go Tools - Ferramentas e bibliotecas no OpenIM para Go.
• Makefile Tools - Melhores práticas e ferramentas para Makefile.
• Script Tools - Melhores práticas e ferramentas para scripts.

Conversions

Esta seção apresenta várias convenções e políticas dentro do OpenIM, abrangendo código, logs, versões e mais.

• API Conversions - Diretrizes e métodos para conversões de API.
• Logging Policy - Políticas e convenções de registro no OpenIM.
• CI/CD Actions - Procedimentos e convenções para CI/CD.
• Commit Conventions - Convenções para commits de código no OpenIM.
• Directory Conventions - Estrutura de diretórios e convenções dentro do OpenIM.
• Error Codes - Lista e descrições de códigos de erro.
• Go Code Conversions - Convenções e conversões para código Go.
• Docker Image Strategy - Estratégias de gerenciamento para imagens Docker do OpenIM, abrangendo várias arquiteturas e repositórios de imagens.
• Logging Conventions - Convenções mais detalhadas sobre registro.
• Version Conventions - Estratégias de nomeação e gerenciamento para versões do OpenIM.

Para Desenvolvedores, Contribuidores e Mantenedores da Comunidade

Desenvolvedores & Contribuidores

Se você é um desenvolvedor ou alguém interessado em contribuir:

• Familiarize-se com nossas Code Conventions e Git Workflow para garantir contribuições suaves.
• Mergulhe no Development Guide para se familiarizar com as práticas de desenvolvimento no OpenIM.

Mantenedores da Comunidade

Como mantenedor da comunidade:

• Garanta que as contribuições estejam alinhadas com os padrões descritos em nossa documentação.
• Reveja regularmente a Logging Policy e Error Codes para se manter atualizado.

Para Usuários

Os usuários devem prestar atenção especial a:

• Docker Installation - Necessário se você planeja usar imagens Docker do OpenIM.
• Docker Image Strategy - Para entender as diferentes imagens disponíveis e como escolher a certa para a sua arquitetura.