Skip to content

Latest commit

 

History

History
140 lines (87 loc) · 6.55 KB

CONTRIBUTING.md

File metadata and controls

140 lines (87 loc) · 6.55 KB
Raw

Contributing to this project

🇺🇸 English version

Contributing to open-source is like joining a stranger's party. Before jumping in with your own suggestions, start by learning how to read the room. This increases the chances that your ideas are noticed and heard. Every community is different, so start by familiarizing yourself with people, documents, tools, ways of working, and so on.

We love your input! We want to make contributing to this project 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

We Develop with Github

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

We Use Github Flow, So All Code Changes Happen Through Pull Requests

Pull requests are the best way to propose changes to the codebase (we use Github Flow). We actively welcome your pull requests:

  1. Fork the repo and create your branch from main.
  2. If you've added code that should be tested, add tests.
  3. If you've changed APIs, update the documentation.
  4. Ensure the test suite passes.
  5. Make sure your code lints.
  6. Issue that pull request!

Any contributions you make will be under the same license as the project's license

In short, when you submit code changes, your submissions are understood to be under the same license that covers the project. Feel free to contact the maintainers if that's a concern.

Report bugs using Github's issues

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

Write bug reports with detail, background, and sample code

This is an example of a bug report I wrote, and I think it's not a bad model. Here's another example from Craig Hockenberry, an app developer whom I greatly respect.

Great Bug Reports tend to have:

  • A quick summary and/or background
  • Steps to reproduce
    • Be specific!
    • Give sample code if you can. My stackoverflow question includes sample code that anyone with a base R setup can run to reproduce what I was seeing
  • What you expected would happen
  • What actually happens
  • Notes (possibly including why you think this might be happening, or stuff you tried that didn't work)

People love thorough bug reports. I'm not even kidding.

Use a Consistent Coding Style

I'm again borrowing these from Facebook's Guidelines

  • 2 spaces for indentation rather than tabs
  • You can try running npm run lint for style unification

License

By contributing, you agree that your contributions will be licensed under the project's license.

References

This document was adapted from the open-source contribution guidelines for Facebook's Draft

🇧🇷 Versão em português

Lembre-se: contribuir para novos projetos é que nem participar de uma festa com pessoas que você não conhece, então sugerimos que primeiro você se familiarize com as pessoas (contribuidores e mantenedores), as documentações, ferramentas e os métodos de trabalho que estão sendo utilizados.

Nós adoraríamos sua sugestão! Queremos facilitar o processo para que você possa contribuir para este projeto da forma mais fácil e objetiva o possível, independente de qual seja sua contribuição. Sugerimos que você:

  • Reporte um bug
  • Discuta o estado atual de um código
  • Submeta uma correção
  • Proponha novas funcionalidades
  • Se torne um mantenedor

Nós usamos o Github para desenvolver

Nós usamos o Github para desenvolver, para monitorar os bugs, ouvir as sugestões de melhorias e aceitar pull requests.

Nós usamos Github Flow, então todos os códigos mudamos através de pull requests

Pull requests são a melhor forma de propôr mudanças para o códigobase (usamos Github Flow). Nós ativamente aceitamos suas pull requests:

  1. Faça um fork do repositório
  2. Se você tiver adicionado código que deve ser testado, adicione testes.
  3. Se você tiver mudado APIs, atualize a documentação.
  4. Verifique se o teste está correto.
  5. Verifique se seu código linta.
  6. Envie sua pull request!

Quaisquer contribuições que você fizer serão sob a mesma licença que o projeto

Resumindo, quando você enviar código novo, suas alterações serão consideradas sob a mesma licença que o projeto. Se você tem alguma dúvida, entre em contato com o mantenedor.

Reportar bugs usando o Github's issues

Nós utilizamos Github's issues para reportar bugs. Reporte um bug reportando um novo issue; simples assim!

Escreva bug reports com detalhes, background, e código de exemplo

Esse é um exemplo de um bug report que eu escrevi. Aqui está outro exmplo do Craig Hockenberry.

** Bons bug reports** tendem a ter:

  • Um resumo e/ou background
  • Passos para reproduzir
    • Seja específico!
    • Dê código de exemplo se possível. Meu Stackoverflow question inclui código de exemplo que qualquer pessoa com um ambiente base R pode executar para reproduzir o que eu estava verificando
  • O que você esperava que acontecesse
  • O que aconteceu
  • Anotações (que possa incluir uma razão por que você acha que isso possa ter acontecido, ou coisas que você tentou que não funcionaram)

Todo mundo gosta de explicações detalhadas sobre bugs!

Utilize um estilo consistente de código

Estou novamente utilizando o Guia do Facebook

  • 2 espaços para identação, não use tabs
  • Você pode tentar rodar npm run lint para verificar que o código está consistente

Licença

Ao contribuir, você aceita que suas contribuições serão licenciadas sob a mesma licença que o projeto.

Referências

Esse documento foi adaptado do projeto open-source Facebook's Draft