Contributing to Lennarb

We love your input! We want to make contributing to Lennarb as easy and transparent as possible, whether it’s:

  • Reporting a bug

  • Discussing the current state of the code

  • Submitting a fix

  • Proposing new features

  • Becoming a maintainer

Development Process

We use GitHub to host code, to track issues and feature requests, as well as accept pull requests.

Pull Requests

  1. Fork the repository

  2. Create your feature branch (git checkout -b feature/amazing-feature)

  3. Commit your changes (git commit -am 'Add amazing feature')

  4. Push to the branch (git push origin feature/amazing-feature)

  5. Open a Pull Request

Pull Request Process

  1. Ensure any install or build dependencies are removed before the end of the layer when doing a build.

  2. Update the README.md with details of changes to the interface, this includes new environment variables, exposed ports, useful file locations, and container parameters.

  3. Increase the version numbers in any examples files and the README.md to the new version that this Pull Request would represent. The versioning scheme we use is SemVer.

  4. You may merge the Pull Request once you have the sign-off of at least one other developer, or if you do not have permission to do that, you may request the reviewer to merge it for you.

Reporting Bugs

We use GitHub issues to track public bugs. Report a bug by opening a new issue; it’s that easy!

Bug Report Template

Title: Short description of the bug

Description: - Current Behavior: A clear and concise description of what the bug is. - Expected Behavior: A clear and concise description of what you expected to happen. - Steps To Reproduce: Steps to reproduce the behavior: 1. Go to ‘…’ 2. Click on ‘.…’ 3. Scroll down to ‘.…’ 4. See error - Environment: - Ruby version: - OS: - Lennarb version: - Additional Context: Add any other context about the problem here.

Code Style

Maintain the code style used throughout the project:

  • Follow Ruby style guidelines

  • Use meaningful variable and function names

  • Comment your code when necessary

  • Keep your code clean and maintainable

License

By contributing, you agree that your contributions will be licensed under the project’s MIT License.

Contribuindo para o Lennarb

Adoramos seu input! Queremos tornar a contribuição para o Lennarb o mais fácil e transparente possível, seja:

  • Reportando um bug

  • Discutindo o estado atual do código

  • Enviando uma correção

  • Propondo novos recursos

  • Tornando-se um mantenedor

Processo de Desenvolvimento

Usamos o GitHub para hospedar código, rastrear problemas e solicitações de recursos, bem como aceitar pull requests.

Pull Requests

  1. Faça um fork do repositório

  2. Crie sua branch de recurso (git checkout -b feature/recurso-incrivel)

  3. Faça commit de suas alterações (git commit -am 'Adicionar recurso incrível')

  4. Envie para a branch (git push origin feature/recurso-incrivel)

  5. Abra um Pull Request

Processo de Pull Request

  1. Certifique-se de que todas as dependências de instalação ou compilação sejam removidas antes do fim da camada ao fazer uma compilação.

  2. Atualize o README.md com detalhes das alterações na interface, incluindo novas variáveis de ambiente, portas expostas, localizações úteis de arquivos e parâmetros de contêiner.

  3. Aumente os números de versão em quaisquer arquivos de exemplos e o README.md para a nova versão que este Pull Request representaria. O esquema de versionamento que usamos é SemVer.

  4. Você pode mesclar o Pull Request depois de ter a aprovação de pelo menos um outro desenvolvedor, ou se não tiver permissão para isso, poderá solicitar ao revisor que o mescle para você.

Reportando Bugs

Usamos issues do GitHub para rastrear bugs públicos. Reporte um bug abrindo uma nova issue; é simples assim!

Modelo de Relatório de Bug

Título: Breve descrição do bug

Descrição: - Comportamento Atual: Uma descrição clara e concisa do bug. - Comportamento Esperado: Uma descrição clara e concisa do que você esperava que acontecesse. - Passos Para Reproduzir: Passos para reproduzir o comportamento: 1. Vá para ‘…’ 2. Clique em ‘.…’ 3. Role para baixo até ‘.…’ 4. Veja o erro - Ambiente: - Versão do Ruby: - Sistema Operacional: - Versão do Lennarb: - Contexto Adicional: Adicione qualquer outro contexto sobre o problema aqui.

Estilo de Código

Mantenha o estilo de código usado em todo o projeto:

  • Siga as diretrizes de estilo Ruby

  • Use nomes significativos para variáveis e funções

  • Comente seu código quando necessário

  • Mantenha seu código limpo e de fácil manutenção

Licença

Ao contribuir, você concorda que suas contribuições serão licenciadas sob a Licença MIT do projeto.