这是indexloc提供的服务,不要输入任何密码
Skip to content
Closed
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
137 changes: 137 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,137 @@
# Contributing to this project

<details>
<summary>🇺🇸 English version</summary>

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](https://guides.github.com/introduction/flow/index.html), So All Code Changes Happen Through Pull Requests

Pull requests are the best way to propose changes to the codebase (we use [Github Flow](https://guides.github.com/introduction/flow/index.html)). 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](http://stackoverflow.com/q/12488905/180626) of a bug report I wrote, and I think it's not a bad model. Here's [another example from Craig Hockenberry](http://www.openradar.me/11905408), 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](http://stackoverflow.com/q/12488905/180626) 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.

## Out styling code

- Refer to PEP-8
- 4 spaces for indentation
- Linhas de até 80 caracteres
- We use black linter as a standard formatter
- Run `black -S twitch_bot` to verify code consistency

## 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](https://github.com/facebook/draft-js/blob/a9316a723f9e918afde44dea68b5f9f39b7d9b00/CONTRIBUTING.md)

</details>

<details open>

<summary>🇧🇷 Versão em português</summary>

Nós adoraríamos sua sugestão! Queremos deixar a contribuição para este projeto assim fácil quanto possível, independente de onde ela seja:

- Reportando um bug
- Discutindo o estado atual do código
- Submetendo uma correção
- Propondo novas funcionalidades
- Ser 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](https://guides.github.com/introduction/flow/index.html), 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](https://guides.github.com/introduction/flow/index.html)). 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](http://stackoverflow.com/q/12488905/180626) de um bug report que eu escrevi. Aqui está outro exmplo do [Craig Hockenberry](http://www.openradar.me/11905408).

** 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](http://stackoverflow.com/q/12488905/180626) 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!

## Nosso Estilo de código

- 4 espaços para identação, não use tabs
- Linhas de até 80 caracteres
- Utilizamos black como linter padrão
- Você pode tentar rodar `black -S twitch_bot` 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](https://github.com/facebook/draft-js/blob/a9316a723f9e918afde44dea68b5f9f39b7d9b00/CONTRIBUTING.md)

</details>