From 482c9a45fead04446f153f6175f1626f806428e4 Mon Sep 17 00:00:00 2001 From: Juliana Fajardini Date: Sat, 7 Oct 2023 16:31:12 -0300 Subject: [PATCH] =?UTF-8?q?Formata=20vers=C3=A3o=20em=20ingl=C3=AAs=20do?= =?UTF-8?q?=20Contributing?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Para facilitar leitura e edição, quebra as linhas em por volta de 90 caracteres. --- .github/CONTRIBUTING-en-US.md | 36 ++++++++++++++++++++++++----------- 1 file changed, 25 insertions(+), 11 deletions(-) diff --git a/.github/CONTRIBUTING-en-US.md b/.github/CONTRIBUTING-en-US.md index 83ebcc6a..ac20fcf3 100644 --- a/.github/CONTRIBUTING-en-US.md +++ b/.github/CONTRIBUTING-en-US.md @@ -3,17 +3,20 @@ Contribution Guide === -This guide is intended to provide guidance to people on their journey with the *Querido Diário* (Dear -Diary) project. It outlines the initial steps that should be taken when interacting with -all of the project's repositories. +This guide is intended to provide guidance to people on their journey with the *Querido +Diário* (Dear Diary) project. It outlines the initial steps that should be taken when +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. +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. # Contributing ## Code of Conduct -To ensure our community is welcoming to all people, please read and follow our [Code of Conduct](CODE_OF_CONDUCT-en-US.md) in all of our community spaces. +To ensure our community is welcoming to all people, please read and follow our +[Code of Conduct](CODE_OF_CONDUCT-en-US.md) in all of our community spaces. By participating in this project, you agree to be bound by the terms specified therein. @@ -35,7 +38,9 @@ whatever they feel more affinity with: ## How to contribute -Knowing `git` and how the *GitHub* platform works is a crucial step. We recommend this [Digital Ocean tutorial](https://www.digitalocean.com/community/tutorials/how-to-use-git-effectively) if you are not familiar with them. +Knowing `git` and how the *GitHub* platform works is a crucial step. We recommend this +[Digital Ocean tutorial](https://www.digitalocean.com/community/tutorials/how-to-use-git-effectively) +if you are not familiar with them. ### Figuring out what to contribute with @@ -44,18 +49,27 @@ Knowing `git` and how the *GitHub* platform works is a crucial step. We recommen 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 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. -- Whether or not you've already chosen an *issue* to work on, you can also comment on relevant questions regarding the task. +- 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. +- 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 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. +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 +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. #### Discussions In case you have an idea or suggestion for the project's direction, open a **Discussion**. -- As *Querido Diário* is made up of many repositories and discussions tend to be transversal, it is **a management's decision** to keep them all centralized. So, to start or follow discussions, just look at the tab [`Discussion` in `querido-diario-community`](https://github.com/okfn-brasil/querido-diario-comunidade/discussions). +- As *Querido Diário* is made up of many repositories and discussions tend to be transversal, +it is **a management's decision** to keep them all centralized. So, to start or follow +discussions, just look at the tab [`Discussion` in `querido-diario-community`](https://github.com/okfn-brasil/querido-diario-comunidade/discussions). #### Community chat