From 0dca145d3a815dfd42af8d29744006c1bbd6e93e Mon Sep 17 00:00:00 2001 From: Ana Carolina Date: Sun, 15 Sep 2024 19:53:51 -0300 Subject: [PATCH 1/2] Translate contribution-guide.rst to EN Signed-off-by: Ana Carolina --- .../contributing/contribution-guide.rst | 48 ++++++++++++++----- 1 file changed, 36 insertions(+), 12 deletions(-) diff --git a/docs/en/source/contributing/contribution-guide.rst b/docs/en/source/contributing/contribution-guide.rst index 0f2a94fc..a44159f0 100644 --- a/docs/en/source/contributing/contribution-guide.rst +++ b/docs/en/source/contributing/contribution-guide.rst @@ -7,7 +7,7 @@ interacting with all of the project's repositories. Each repository has specific characteristics, described in their own documentation. Once you have finished reading these general guidelines, please read also the -`CONTRIBUTING.md` file of the repository you are interested in before making your contribution. +`README.md` and `CONTRIBUTING.md` files of the repository you are interested in contributing, since they have more specific information about the development environment, installation, execution, goals, the dynamics of interaction in Pull Requests (PR), etc. Code of Conduct ******************** @@ -32,35 +32,49 @@ whatever they feel more affinity with: - Frontend - https://github.com/okfn-brasil/querido-diario-frontend - Documentation - https://github.com/okfn-brasil/querido-diario-comunidade -How to contribute +Finding out what to contribute =========================== Knowing `git`_ and how the `GitHub`_ platform works is a crucial step. We recommend this -`Digital Ocean tutorial`_ if you are not familiar with them. +`Digital Ocean tutorial`_ if you are not familiar with them yet. Issues ------------ On the **Issues** tab of the chosen repository, there are tasks or issues specific to that repository. Check to see if any of them interest you. -- When a task is suitable for beginners, it will be labeled as `good first issue`. +- When a task is suitable for beginners, it will be labeled as `good first issue`. When it is an important task, aligned with the project goals, it will have the `priority` label. - When you find a task that looks interesting to you, comment that you will do that task. That way, other folks will know that you're already working on it, and can offer to help you or take on other tasks that haven't been worked on yet. +- If the task has a comment announcing someone's interest in working on it, but does not have a linked pull request and the comment is more than 1 month old, consider the issue available. - Whether or not you've already chosen an *issue* to work on, you can also comment on relevant questions regarding the task. Milestones ------------ -If there are no open *issues* or none interest you, look at the **Milestones** of the -repository you want to contribute to. These indicate the goals to be achieved. Exploring +If there are no open *issues* or none interest you, check the **Milestones** of the +repository. These indicate the goals to be achieved. Exploring the project files looking for areas for improvement that would help the repository reach a *milestone* is an excellent way of contributing. -- When you find something, open an *issue* describing the potential improvement. If you are also planning to work on that task, add that to the issue. +- When you find something, open an *issue* describing the potential improvement and how it relates to one of the milestones. If you are also planning to work on that task, add that to the issue. -Community chat +Boards +------------ +Displayed in the Projects tab, **Boards** are resources that group issues of the same theme from one or more repositories in a centralized location, making it easier to navigate through available tasks. See what our `Boards`_ are. + +Roadmap +------------ +The `roadmap`_ is a special board that records the strategic direction that *Querido Diário* has on the horizon, the currently prioritized goals and the progress made. +- If you would like to suggest new goals for the roadmap, create an issue in the `community repository`_ using the "Roadmap Item" template. + +Online community ------------------------ +- Join the OKBR `Discord`_. There you can quickly ask questions, interact with the maintainers, ask how you can help, and even chat with other contributors. +- We also organize and promote activities on Discord such as sprints, regular meetings, pairings, on-call sessions, etc. All of these activities are open and can be followed through this `public calendar`_. -Join our `community`_. There, you'll be able to ask quick questions, interact with the project maintainers, learn about how can you -help and chat with other *Querido Diário* contributors. +*Querido Diário* General Meeting +------------------------------- +Always on the last Thursday of the month, at 6 pm (São Paulo time/GMT-3), the *Querido Diário* General Meeting takes place on Discord, which is attended by the OKBR Civic Innovation team, maintainers and contributors. +- This meeting serves as an internal alignment of the community regarding the various development fronts that may be taking place and, on the other hand, it serves as a gateway for interested people, since it is a panoramic meeting, allowing them to get to know the people involved and the activities taking place. Interacting with reviewers ==================================== @@ -68,7 +82,12 @@ Interacting with reviewers - Be patient, and give reviewers some time. In addition to contribution reviews being complex and demanding time and attention by themselves, a reviewer can be - just like you - another contributor, who's volunteering their personal time when possible, or has other priorities before being able to review your contribution. - Whether in the form of code or messages with questions and suggestions, try to be objective, but giving details when necessary, to facilitate interactions. - 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 GitHub interface. That means that both of you agree with the implemented modifications and the contribution can move on. -- Sometimes the community organizes events for solving multiple issues in a short amount of time. Especially in these cases, an issue or pull request may be considered abandoned when is waiting for the contributor but doesn't receive updates for a couple of weeks. Just let us know you need more time, so we don't end up closing it by mistake. + +Important +---------------------- +*Querido Diário* has several repositories and a limited number of maintainers for each one. Therefore, it may take some time to review a contribution, especially if it is not related to a project goal (mapped in the `roadmap`_). + +If you have any questions about this and would like to better understand how to contribute with review and/or priority tasks, please contact us via Discord and join the :ref:`general meeting<*Querido Diário* General Meeting>`. Maintaining ************************ @@ -91,4 +110,9 @@ Responsibilities of a *Querido Diário* maintainer .. _git: https://pt.wikipedia.org/wiki/Git .. _GitHub: https://docs.github.com/pt/get-started/quickstart/hello-world .. _Digital Ocean tutorial: https://www.digitalocean.com/community/tutorials/how-to-use-git-effectively -.. _community: https://go.ok.org.br/discord \ No newline at end of file +.. _community: https://go.ok.org.br/discord +.. _roadmap: https://github.com/orgs/okfn-brasil/projects/14/views/1 +.. _Discord: https://go.ok.org.br/discord +.. _community repository: https://github.com/okfn-brasil/querido-diario-comunidade/issues +.. _Boards: https://github.com/orgs/okfn-brasil/projects?query=is%3Aopen +.. _public calendar: https://go.ok.org.br/agenda-comunidade From 5d4d84f375e95ddc1ed1d400c7bc3bb3a0f203b0 Mon Sep 17 00:00:00 2001 From: trevineju Date: Fri, 8 Nov 2024 14:40:35 -0300 Subject: [PATCH 2/2] =?UTF-8?q?Remove=20referencias=20=C3=A0=20reuniao=20g?= =?UTF-8?q?eral=20do=20QD?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- docs/en/source/contributing/contribution-guide.rst | 7 +------ .../source/contribuindo/guia-de-contribuicao.rst | 12 +----------- 2 files changed, 2 insertions(+), 17 deletions(-) diff --git a/docs/en/source/contributing/contribution-guide.rst b/docs/en/source/contributing/contribution-guide.rst index a44159f0..3364b6ef 100644 --- a/docs/en/source/contributing/contribution-guide.rst +++ b/docs/en/source/contributing/contribution-guide.rst @@ -71,11 +71,6 @@ Online community - Join the OKBR `Discord`_. There you can quickly ask questions, interact with the maintainers, ask how you can help, and even chat with other contributors. - We also organize and promote activities on Discord such as sprints, regular meetings, pairings, on-call sessions, etc. All of these activities are open and can be followed through this `public calendar`_. -*Querido Diário* General Meeting -------------------------------- -Always on the last Thursday of the month, at 6 pm (São Paulo time/GMT-3), the *Querido Diário* General Meeting takes place on Discord, which is attended by the OKBR Civic Innovation team, maintainers and contributors. -- This meeting serves as an internal alignment of the community regarding the various development fronts that may be taking place and, on the other hand, it serves as a gateway for interested people, since it is a panoramic meeting, allowing them to get to know the people involved and the activities taking place. - Interacting with reviewers ==================================== @@ -87,7 +82,7 @@ Important ---------------------- *Querido Diário* has several repositories and a limited number of maintainers for each one. Therefore, it may take some time to review a contribution, especially if it is not related to a project goal (mapped in the `roadmap`_). -If you have any questions about this and would like to better understand how to contribute with review and/or priority tasks, please contact us via Discord and join the :ref:`general meeting<*Querido Diário* General Meeting>`. +If you have any questions about this and would like to better understand how to contribute with review and/or priority tasks, please contact us via Discord. Maintaining ************************ diff --git a/docs/pt_BR/source/contribuindo/guia-de-contribuicao.rst b/docs/pt_BR/source/contribuindo/guia-de-contribuicao.rst index 05138c2a..33b036b3 100644 --- a/docs/pt_BR/source/contribuindo/guia-de-contribuicao.rst +++ b/docs/pt_BR/source/contribuindo/guia-de-contribuicao.rst @@ -84,15 +84,6 @@ Comunidade online - Ingresse no `Discord da OKBR`_. Lá você poderá tirar dúvidas mais rápidas, interagir com as pessoas mantenedoras, perguntar como poderia ajudar e ainda conversar com outras pessoas que também contribuem. - Também no Discord, organizamos e promovemos atividades como *sprints*, reuniões periódicas, pareamentos, plantões, etc. Todas essas atividades são abertas e podem ser acompanhadas por meio desta `agenda pública`_. -Reunião Geral do Querido Diário ---------------------------------- - -Sempre na última quinta-feira do mês, às 18h, acontece, no Discord, a Reunião Geral -do Querido Diário, que conta com a presença da equipe de Inovação Cívica da OKBR, -pessoas mantenedoras e contribuidoras. - -- Por um lado, esta reunião cumpre o papel alinhamento interno da comunidade quanto às diversas frentes de desenvolvimento que podem estar ocorrendo. E, por outro, serve de porta de entrada para pessoas interessadas, visto que é uma reunião de caráter panorâmico, permitindo conheçam as pessoas envolvidas e atividades acontecendo. - Interagindo com a pessoa revisora ==================================== @@ -106,8 +97,7 @@ Interagindo com a pessoa revisora especialmente se ela não estiver relacionada a uma meta do projeto (mapeada no `roadmap`_). Caso tenha dúvidas sobre isso e gostaria de entender melhor como contribuir - com revisão e/ou em tarefas prioritárias, entre em contato pelo Discord e participe - da :ref:`reunião geral`. + com revisão e/ou em tarefas prioritárias, entre em contato pelo Discord. Mantendo