Skip to content

Commit a3c6b1b

Browse files
davorpadavorpa
committed
Homogenize HowTo's
- Add H1 header - `Read this` ... right alignmements - Split a bit first paragraph to highlight welcome. - Introduce Pull Request acronym. - trademarks / typos: GitHub, YouTube, Pull Request - Update GitHub links urls. `help`/`guides` subdomain was moved to `docs` so now a 301 Redirect is skipped. - Details block added, with center align. When clicked, the contributor graphs is toggled. - Some bolds to highlight common resources formating issues (like in CONTRIBUTING) - Repo name in monospace font - Re-worded last part of 4th paragraph to explain that no new PR is needed to open if there are linter errors or changes are requested. Now it's more clear, I thought. Via #6590
1 parent 84438cb commit a3c6b1b

File tree

2 files changed

+49
-15
lines changed

2 files changed

+49
-15
lines changed

Diff for: ‎docs/HOWTO-es.md

+22-5
Original file line numberDiff line numberDiff line change
@@ -1,17 +1,34 @@
1+
# Primeros pasos
2+
3+
<div align="right" markdown="1">
4+
15
*[Lea esto en otros idiomas](../README.md#translations)*
26

3-
¡Sea bienvenido a *Free-Programming-Books*! Damos una calurosa bienvenida a los nuevos colaboradores; incluso a aquellos que realizan su primera Pull Request (PR) en GitHub. Si es usted uno de ellos, aquí van algunos recursos que quizás le pueden ayudar:
7+
</div>
8+
9+
**¡Sea bienvenido a `Free-Programming-Books`!**
10+
11+
Le damos una calurosa bienvenida los nuevos colaboradores; incluso a aquellos que realizan su primera Pull Request (PR) en GitHub. Si es usted uno de ellos, aquí van algunos recursos que quizás le pueden ayudar:
412

513
* [Acerca de las Pull Requests](https://docs.github.com/es/github/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests)
614
* [Creando una Pull Request](https://docs.github.com/es/github/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/creating-a-pull-request)
7-
* [GitHub Hola Mundo](https://guides.github.com/activities/hello-world/) *(en inglés)*
15+
* [GitHub Hola Mundo](https://docs.github.com/en/get-started/quickstart/hello-world) *(en inglés)*
816
* [Youtube - Tutorial GitHub para principiantes](https://www.youtube.com/watch?v=0fKg7e37bQE) *(en inglés)*
917
* [Youtube - Como bifurcar un repositorio GitHub y Enviar una Pull Request](https://www.youtube.com/watch?v=G1I3HF4YWEw) *(en inglés)*
1018
* [Youtube - Curso intensivo de Markdown](https://www.youtube.com/watch?v=HUBNt18RFbo) *(en inglés)*
1119

1220

13-
No se quede nunca con la duda, ni tenga miedo de hacer preguntas; todo colaborador que usted ve en el repositorio, comenzó en su día con una primera PR. ¡Qué tal si es nuestro mil-milésimo primer!
21+
No se quede nunca con dudas, ni tenga miedo de hacer preguntas; todo buen colaborador que usted puede ver en el repositorio, comenzó en su día con una primera PR. Así que... ¿qué tal si se une a [nuestra extensa y creciente](https://www.apiseven.com/en/contributor-graph?chart=contributorOverTime&repo=ebookfoundation/free-programming-books) communidad?
22+
23+
<details align="center" markdown="1">
24+
<summary>Detalles sobre dicho crecimiento</summary>
25+
26+
[![EbookFoundation/free-programming-books's Contributor over time Graph](https://contributor-overtime-api.apiseven.com/contributors-svg?chart=contributorOverTime&repo=ebookfoundation/free-programming-books)](https://www.apiseven.com/en/contributor-graph?chart=contributorOverTime&repo=ebookfoundation/free-programming-books)
27+
28+
[![EbookFoundation/free-programming-books's Monthly Active Contributors graph](https://contributor-overtime-api.apiseven.com/contributors-svg?chart=contributorMonthlyActivity&repo=ebookfoundation/free-programming-books)](https://www.apiseven.com/en/contributor-graph?chart=contributorMonthlyActivity&repo=ebookfoundation/free-programming-books)
29+
30+
</details>
1431

15-
Incluso si ya tiene algo de experiencia como colaborador en otros proyectos de código abierto, hay algunas cosas que pueden hacerle dar un traspiés. Una vez enviada su PR, *GitHub Actions* ejecutará un *linter*; el cuál se encarga a menudo de encontrar pequeños problemas con el espaciado, enlazado, sintaxis o la alfabetización. Si al finalizar este proceso de integración continua se enciende la luz verde, es que todo está listo para su revisión; pero si no, haga clic en los "enlaces de Detalle" que proporciona para averiguar qué fue exactamente lo que falló. Solucione dicho problema y agregue los cambios a su PR mediante un nuevo commit.
32+
Incluso si ya tiene algo de experiencia como colaborador en otros proyectos de código abierto, hay algunas cosas que pueden hacerle dar un traspiés. Una vez enviada su PR, ***GitHub Actions* ejecutará un *linter*; el cuál se encarga a menudo de encontrar pequeños problemas con el espaciado, enlazado, sintaxis o la alfabetización**. Si al finalizar este proceso de integración continua se enciende la luz verde, es que todo está listo para su revisión; pero si no, haga clic en los "enlaces de Detalle" que proporciona para averiguar qué fue exactamente lo que falló. Solucione dicho problema y agregue los cambios a su PR mediante un nuevo commit sobre la rama con la que inició su petición de cambios.
1633

17-
Por último, si no está del todo seguro de si el recurso que desea agregar es apropiado para *Free-Programming-Books*, lea detenidamente las pautas que puede encontrar en [CONTRIBUTING](CONTRIBUTING-es.md) ([traducciones / otros idiomas](../README.md#translations)).
34+
Por último, si no está del todo seguro de si el recurso que desea agregar es apropiado para `Free-Programming-Books`, lea detenidamente las pautas que puede encontrar en [CONTRIBUTING](CONTRIBUTING-es.md) (también disponible [traducciones / otros idiomas](../README.md#translations)).

Diff for: ‎docs/HOWTO.md

+27-10
Original file line numberDiff line numberDiff line change
@@ -1,17 +1,34 @@
1+
# How-To at a glance
2+
3+
<div align="right" markdown="1">
4+
15
*[Read this in other languages](../README.md#translations)*
26

3-
Welcome to Free-Programming-Books! We welcome new contributors; even those making their very first pull request on Github. If you're one of those, here are some resources that might help:
7+
</div>
8+
9+
**Welcome to `Free-Programming-Books`!**
10+
11+
We welcome new contributors; even those making their very first Pull Request (PR) on GitHub. If you're one of those, here are some resources that might help:
12+
13+
* [About Pull Requests](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests)
14+
* [Creating a Pull Requests](https://docs.github.com/en/free-pro-team@latest/github/collaborating-with-issues-and-pull-requests/creating-a-pull-request)
15+
* [GitHub Hello World](https://docs.github.com/en/get-started/quickstart/hello-world)
16+
* [YouTube - GitHub Tutorial For Beginners](https://www.youtube.com/watch?v=0fKg7e37bQE)
17+
* [YouTube - How To Fork A GitHub Repo and Submit A Pull Request](https://www.youtube.com/watch?v=G1I3HF4YWEw)
18+
* [YouTube - Markdown Crash Course](https://www.youtube.com/watch?v=HUBNt18RFbo)
19+
20+
21+
Don't hesitate to ask questions; every contributor started with a first PR. So... why not join our [large, growing](https://www.apiseven.com/en/contributor-graph?chart=contributorOverTime&repo=ebookfoundation/free-programming-books) community.
22+
23+
<details align="center" markdown="1">
24+
<summary>Details about that growth</summary>
425

5-
* [About Pull Requests](https://help.github.com/articles/about-pull-requests/)
6-
* [Creating a pull request](https://docs.github.com/en/free-pro-team@latest/github/collaborating-with-issues-and-pull-requests/creating-a-pull-request)
7-
* [Github Hello World](https://guides.github.com/activities/hello-world/)
8-
* [Youtube - Github Tutorial For Beginners](https://www.youtube.com/watch?v=0fKg7e37bQE)
9-
* [Youtube - How To Fork A GitHub Repo and Submit A Pull Request](https://www.youtube.com/watch?v=G1I3HF4YWEw)
10-
* [Youtube - Markdown Crash Course](https://www.youtube.com/watch?v=HUBNt18RFbo)
26+
[![EbookFoundation/free-programming-books's Contributor over time Graph](https://contributor-overtime-api.apiseven.com/contributors-svg?chart=contributorOverTime&repo=ebookfoundation/free-programming-books)](https://www.apiseven.com/en/contributor-graph?chart=contributorOverTime&repo=ebookfoundation/free-programming-books)
1127

28+
[![EbookFoundation/free-programming-books's Monthly Active Contributors graph](https://contributor-overtime-api.apiseven.com/contributors-svg?chart=contributorMonthlyActivity&repo=ebookfoundation/free-programming-books)](https://www.apiseven.com/en/contributor-graph?chart=contributorMonthlyActivity&repo=ebookfoundation/free-programming-books)
1229

13-
Don't hesitate to ask questions; every contributor started with a first PR. So... why not join our [large, growing](https://contributor-graph-api.apiseven.com/contributors-svg?repo=EbookFoundation/free-programming-books) community.
30+
</details>
1431

15-
Even if you're an experienced open source contributor, there are things that might trip you up. Once you've submitted your PR, GitHub Actions will run a linter, often finding little issues with spacing or alphabetization. If you get a green button, everything is ready for review, but if not, click "Details" under the check that failed to find out what the linter didn't like. Fix the problem and add a commit to your PR.
32+
Even if you're an experienced open source contributor, there are things that might trip you up. Once you've submitted your PR, ***GitHub Actions* will run a *linter*, often finding little issues with spacing or alphabetization**. If you get a green button, everything is ready for review; but if not, click "Details" under the check that failed to find out what the linter didn't like, and fix the problem adding a new commit to the branch from which your PR was opened.
1633

17-
Finally, if you're not sure that the resource you want to add is appropriate for Free-Programming-Books, read through the guidelines in [CONTRIBUTING](CONTRIBUTING.md). ([translations](../README.md#translations))
34+
Finally, if you're not sure that the resource you want to add is appropriate for `Free-Programming-Books`, read through the guidelines in [CONTRIBUTING](CONTRIBUTING.md) *([translations](../README.md#translations) also available)*.

0 commit comments

Comments
 (0)