Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Atualiza versão em inglês do Contributing #74

Merged
merged 2 commits into from
Apr 12, 2024

Conversation

jufajardini
Copy link
Contributor

Closes #33

Os documentos em português e em inglês não estavam mais sincronizados.

Observações:

  • Como é possível fazer contribuições não relacionadas com código, tomei a liberdade de tentar deixar o guia um pouco mais genérico, ou colocando "code" entre parênteses, ou alterando para "contribuição". Vou destacar no arquivo em si, pra ajudar a visualizar.
  • Fiz um commit em separado quebrando as linhas, enquanto pessoa que edita e manté documentação com frequência, tendo a achar melhor para ler e revisar - deixei em commit separado, pois aí posso descartar, e porque fica mais fácil de revisar, também.
  • Fiquei pensando se não seria bom buscar um link de guia pra aprender Git e GH em inglês (ao invés do da Escola de Dados)
  • Uma dúvida: existem planos de começar a fazer os commits também em inglês, já que a ideia é meio que deixar o projeto mais acessível internacionalmente?

@jufajardini jufajardini force-pushed the 33-update-contributing-EN/v1 branch from e124662 to aa2c96a Compare October 7, 2023 20:11
@jufajardini jufajardini force-pushed the 33-update-contributing-EN/v1 branch from aa2c96a to bdb5bb3 Compare October 7, 2023 20:13
@trevineju trevineju added the hacktoberfest-accepted Aceito para Hacktoberfest label Oct 9, 2023
@ogecece
Copy link
Member

ogecece commented Oct 10, 2023

@jufajardini muito legais essas novas perspectivas que você está trazendo! Concordo totalmente com as modificações sobre referências a contribuição com código. Mas antes de entrar nisso, vou começar respondendo as dúvidas e depois endereçando pontos específicos do PR, beleza?

Fiquei pensando se não seria bom buscar um link de guia pra aprender Git e GH em inglês (ao invés do da Escola de Dados)

Boa! É um tópico que fica fácil de localizar, vamos sim. Pode ser esse da Digital Ocean: https://www.digitalocean.com/community/tutorials/how-to-use-git-effectively

Uma dúvida: existem planos de começar a fazer os commits também em inglês, já que a ideia é meio que deixar o projeto mais acessível internacionalmente?

Não. Era assim até 2021-2022. Optamos por usar o português como idioma padrão em tudo exceto o código desde então.

O que vai ficar sendo traduzido para inglês (e eventualmente espanhol) vão ser as principais documentações. E como esse repositório também tem as issues que compõem o Roadmap, então elas também serão traduzidas.

Mas se alguém inicialmente fizer commit em inglês por enquanto não pedimos pra mudar.

E se alguém quiser se comunicar em inglês ou outro idioma, vamos tentar nos comunicar no idioma que a pessoa escolheu, se possível.

Fiz um commit em separado quebrando as linhas, enquanto pessoa que edita e manté documentação com frequência, tendo a achar melhor para ler e revisar - deixei em commit separado, pois aí posso descartar, e porque fica mais fácil de revisar, também.

Massa!

Como é possível fazer contribuições não relacionadas com código, tomei a liberdade de tentar deixar o guia um pouco mais genérico, ou colocando "code" entre parênteses, ou alterando para "contribuição". Vou destacar no arquivo em si, pra ajudar a visualizar.

Achei ótimo! Pode refletir essas modificações no arquivo em português?

@jufajardini
Copy link
Contributor Author

@jufajardini muito legais essas novas perspectivas que você está trazendo! Concordo totalmente com as modificações sobre referências a contribuição com código. Mas antes de entrar nisso, vou começar respondendo as dúvidas e depois endereçando pontos específicos do PR, beleza?

Fiquei pensando se não seria bom buscar um link de guia pra aprender Git e GH em inglês (ao invés do da Escola de Dados)

Boa! É um tópico que fica fácil de localizar, vamos sim. Pode ser esse da Digital Ocean: https://www.digitalocean.com/community/tutorials/how-to-use-git-effectively

Uma dúvida: existem planos de começar a fazer os commits também em inglês, já que a ideia é meio que deixar o projeto mais acessível internacionalmente?

Não. Era assim até 2021-2022. Optamos por usar o português como idioma padrão em tudo exceto o código desde então.

O que vai ficar sendo traduzido para inglês (e eventualmente espanhol) vão ser as principais documentações. E como esse repositório também tem as issues que compõem o Roadmap, então elas também serão traduzidas.

Mas se alguém inicialmente fizer commit em inglês por enquanto não pedimos pra mudar.

E se alguém quiser se comunicar em inglês ou outro idioma, vamos tentar nos comunicar no idioma que a pessoa escolheu, se possível.

Fiz um commit em separado quebrando as linhas, enquanto pessoa que edita e manté documentação com frequência, tendo a achar melhor para ler e revisar - deixei em commit separado, pois aí posso descartar, e porque fica mais fácil de revisar, também.

Massa!

Como é possível fazer contribuições não relacionadas com código, tomei a liberdade de tentar deixar o guia um pouco mais genérico, ou colocando "code" entre parênteses, ou alterando para "contribuição". Vou destacar no arquivo em si, pra ajudar a visualizar.

Achei ótimo! Pode refletir essas modificações no arquivo em português?

Gracias pelas respostas, vou incorporar o feedback aqui, e uma vez que as contribuições aqui sejam aceitas, atualizo a versão em português, sim! /o/

@jufajardini jufajardini force-pushed the 33-update-contributing-EN/v1 branch from bdb5bb3 to 651910b Compare October 10, 2023 23:04
Comment on lines 74 to 75
- During the reviewing process, a reviewer can open *threads* requesting improvements to
your contribution. In general, it is the reviewers' role to decide when a *thread* has ended.
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Esta linha aqui é relativa a marcar as discussões na interface do GH como resolvidas/resolved? Eu tinha achado que era algo mais abstrato, quando estava traduzindo, porque não estou acostumada com esse uso, mas fui pescar em outro PR como era o processo de incorporar feedback de vocês, e aí caiu a ficha que provavelmente era a isso que se referia...

Se for, será que faria sentido colocar uma imagem pra ajudar a visualizar? Ou é algo mais universal, que as pessoas aprendem com tutoriais de git?

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

É exatamente isso mesmo :)

Prefiriria que a gente colocasse imagem de interface (que não temos controle) em último caso para não termos problemas com estilos mudando ou diferenças entre dispositivos.

Mas não, não é algo que se aprende nos tutoriais de git normalmente. Deixar o texto mais explícito funcionaria pra você? Algo como:

During the reviewing process, a reviewer can open threads requesting improvements to your contribution. In general, it is the reviewers' role to decide when a thread has ended and mark it as "resolved" in the interface. That will mean that both of you agree with the implemented modifications and the contribution can move on.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

É exatamente isso mesmo :)

Prefiriria que a gente colocasse imagem de interface (que não temos controle) em último caso para não termos problemas com estilos mudando ou diferenças entre dispositivos.

Beleza! Fatos, por vezes eu me passo nessas paradas...

Mas não, não é algo que se aprende nos tutoriais de git normalmente. Deixar o texto mais explícito funcionaria pra você? Algo como:

During the reviewing process, a reviewer can open threads requesting improvements to your contribution. In general, it is the reviewers' role to decide when a thread has ended and mark it as "resolved" in the interface. That will mean that both of you agree with the implemented modifications and the contribution can move on.

Acho que fica melhor! Vou incorporar, acho que só vou acrescentar um "git hub" no interface :P

@jufajardini jufajardini changed the title Atualiza versão em inglês do Contributing - v1 Atualiza versão em inglês do Contributing Oct 14, 2023
@jufajardini jufajardini force-pushed the 33-update-contributing-EN/v1 branch 2 times, most recently from 482c9a4 to c2fa0b9 Compare October 14, 2023 18:48
@jufajardini
Copy link
Contributor Author

Vi que temos a #35 para melhorar a versão em português, vou mexer nela também - se as tarefas ainda fizerem sentido :P

Aí não sei bem como fica a questão de qual versão vai ser aceita primeiro. Qualquer coisa, eu volto e atualizo o que ficar desatualizado depois, na versão que for xD

@jufajardini jufajardini force-pushed the 33-update-contributing-EN/v1 branch from c2fa0b9 to 582d7f7 Compare October 14, 2023 19:29
Copy link
Member

@ogecece ogecece left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@jufajardini desculpa a demora. O PR acabou demorando pra ser aprovado.

Agradeço demais a paciência!

.github/CONTRIBUTING-en-US.md Show resolved Hide resolved
Os documentos em português e em inglês não estavam mais sincronizados.
Para facilitar leitura e edição, quebra as linhas em por volta de 90
caracteres.
@ogecece ogecece force-pushed the 33-update-contributing-EN/v1 branch from 582d7f7 to 888bee5 Compare April 12, 2024 17:35
@ogecece ogecece merged commit c624c38 into okfn-brasil:main Apr 12, 2024
1 check passed
ogecece added a commit that referenced this pull request Apr 12, 2024
Resolve: #35 

Havia duas indicações de coisas para fazer:
- listar repo de backend - já estava
- adicionar parágrafo sobre PRs ou issues abandonadas - acrescentei, na
seção de interação com as pessoas revisoras
- aproveitei e também formatei o arquivo quebrando linhas em torno de 90
caracteres.

Acho que esta tarefa terá mais uma coisa pra ser feita nela, quando #74
for aceito, já que me pediram pra incorporar umas mudanças introduzidas
lá nessa versão em português.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
hacktoberfest-accepted Aceito para Hacktoberfest
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Atualizar versão em inglês do CONTRIBUTING.md
3 participants