opensourcemirror
/
free-programming-books
mirror of https://github.com/EbookFoundation/free-programming-books.git
1
0
Fork 0
Code Issues Releases Wiki Activity
free-programming-books/docs/HOWTO.md

35 lines
2.7 KiB
Markdown
Raw Permalink Normal View History

docs(howto): Homogenize HowTo's format across translated files (#6724) * 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 EbookFoundation/free-programming-books#6590 * Rewording to be more meaningful * Add H1 header + `Read this` ... aligned to right Via EbookFoundation/free-programming-books#6590 * remove trailing spaces * Split a bit first paragraph to highlight welcome. Via EbookFoundation/free-programming-books#6590 * homogenize `1-2` newlines amount between paragraphs * Update Github documentation links list - Update GitHub links urls. `help`/`guides` subdomain was moved to `docs` so now a 301 Redirect is skipped. - Remove flag emojis from link, perhaps use text in notes format to give accesibility locale context Via EbookFoundation/free-programming-books#6590 * GitHub trademark typos * YouTube trademark typos * `Welcome to fpb!` in bold style * Repo name backticked in monospace font (non-translatable) * reword es-en graph summary * Add a centered details block with graphs about contributions (users vs. time) Detail blocks are toggleable sections in GitHub Provided graphs by apiseven: - Contributor over time Graph - Monthly Active Contributors graph * GitHub trademark typos * Fix pull request typos and introduce it acronym * Update Github documentation links list - Update GitHub links urls. `help`/`guides` subdomain was moved to `docs` so now a 301 Redirect is skipped. - Remove flag emojis from link, perhaps use text in notes format to give accesibility locale context The forgot rest addressed on 7ee485bb3b1f16cd58aa4aacef3f8af19fb588ea commit Via EbookFoundation/free-programming-books#6590 * Some bolds to highlight common resources formating issues (like in CONTRIBUTING) * Fix typos suggested by AhmedElTabarani Co-authored-by: أحمد الطبراني <eltabaraniahmed@gmail.com> * Add paragrah from #5351. Need language translation * New strings translated to `it` Italian Co-authored-by: ImVector <59611597+LuigiImVector@users.noreply.github.com> * use languages not countries. `in Egyptian Arabic` * use languages not countries. `in Algerian Arabic` * remove notes from details block containing graphs about contributions (users vs. time) * Fix spanish typos Co-authored-by: Wonjang Son <sondaniel.88@gmail.com> * Fix korean typos Co-authored-by: Wonjang Son <sondaniel.88@gmail.com> * New strings translated to `ar` Arabic Co-authored-by: أحمد الطبراني <eltabaraniahmed@gmail.com> * New strings translated to `fr` French Co-authored-by: Loic Beylot <loic.beylot@gmail.com> Co-authored-by: أحمد الطبراني <eltabaraniahmed@gmail.com> Co-authored-by: ImVector <59611597+LuigiImVector@users.noreply.github.com> Co-authored-by: Wonjang Son <sondaniel.88@gmail.com> Co-authored-by: Loic Beylot <loic.beylot@gmail.com>
2022-02-28 17:04:55 +01:00
# How-To at a glance
<div align="right" markdown="1">
feat: Add `docs/readme.md` + update crosslinks (#6700) * complete translate list with the new languages appeared since hacktoberfest * Create docs/README.md with the translations section using root README.md as source. Links are adapted to this folder Address EbookFoundation/free-programming-books#6698 * fix remaining url + translation items - Portuguese (Portugal) - Slovak / slovenčina - Slovenian / slovenščina Address EbookFoundation/free-programming-books#6698 * fix remaining url + translation items - Portuguese (Portugal) - Slovak / slovenčina - Slovenian / slovenščina Address EbookFoundation/free-programming-books#6698 * Add inclusiveness `dare to translate...` paragraph * Add inclusiveness `dare to translate...` paragraph * Move translations link target url to docs * move translation links `bs` * move translations link `en` * move translations crosslink `es` * move translations crosslink `fr` * move translations crosslink `de` * move translations crosslink `el` * move translations crosslink `fa_IR` * move translations crosslink `fil` * move translations crosslink `it` * move translations crosslink `pt_BR` * move translations crosslink `ko` * move translations crosslink `ru` * move translations crosslink `id` * move translations crosslink `zh` * move translations crosslink `hi` * move translations crosslink `pl` * move translations crosslink `uk` * move translations crosslink `vi` * move translations crosslink remaining `HOW-To's` * revert feature moved to #6688 * Remove the list from the top level. Leave `en` links * use `previous languages` in root README * Add more languages lists in root `readme.md` * fix typo * fix typo * Update docs/README.md after translations paragraph Less text is more Co-authored-by: Eric Hellman <eric@hellman.net> * Update README.md after translations paragraph Less text is more Co-authored-by: Eric Hellman <eric@hellman.net> * Update README.md preface translations paragraph Co-authored-by: Eric Hellman <eric@hellman.net> * fix CONTRIBUTING target url commited at fd2b39151c7d61c4b4b0bd99a96ed231614b9a15 * Update docs/README.md preface translations paragraph Co-authored-by: Eric Hellman <eric@hellman.net> * read me! said the boss ^^, less text is more. Co-authored-by: Eric Hellman <eric@hellman.net> * remove "The inclusiveness is one of our targets, so " Co-authored-by: Eric Hellman <eric@hellman.net>
2022-02-11 18:27:07 +01:00
*[Read this in other languages](README.md#translations)*
Update HOWTO.md (#4168) Added link of HOWTO-zh.md . **This file is in PR right now, please consider it
2020-10-16 15:57:57 +02:00
docs(howto): Homogenize HowTo's format across translated files (#6724) * 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 EbookFoundation/free-programming-books#6590 * Rewording to be more meaningful * Add H1 header + `Read this` ... aligned to right Via EbookFoundation/free-programming-books#6590 * remove trailing spaces * Split a bit first paragraph to highlight welcome. Via EbookFoundation/free-programming-books#6590 * homogenize `1-2` newlines amount between paragraphs * Update Github documentation links list - Update GitHub links urls. `help`/`guides` subdomain was moved to `docs` so now a 301 Redirect is skipped. - Remove flag emojis from link, perhaps use text in notes format to give accesibility locale context Via EbookFoundation/free-programming-books#6590 * GitHub trademark typos * YouTube trademark typos * `Welcome to fpb!` in bold style * Repo name backticked in monospace font (non-translatable) * reword es-en graph summary * Add a centered details block with graphs about contributions (users vs. time) Detail blocks are toggleable sections in GitHub Provided graphs by apiseven: - Contributor over time Graph - Monthly Active Contributors graph * GitHub trademark typos * Fix pull request typos and introduce it acronym * Update Github documentation links list - Update GitHub links urls. `help`/`guides` subdomain was moved to `docs` so now a 301 Redirect is skipped. - Remove flag emojis from link, perhaps use text in notes format to give accesibility locale context The forgot rest addressed on 7ee485bb3b1f16cd58aa4aacef3f8af19fb588ea commit Via EbookFoundation/free-programming-books#6590 * Some bolds to highlight common resources formating issues (like in CONTRIBUTING) * Fix typos suggested by AhmedElTabarani Co-authored-by: أحمد الطبراني <eltabaraniahmed@gmail.com> * Add paragrah from #5351. Need language translation * New strings translated to `it` Italian Co-authored-by: ImVector <59611597+LuigiImVector@users.noreply.github.com> * use languages not countries. `in Egyptian Arabic` * use languages not countries. `in Algerian Arabic` * remove notes from details block containing graphs about contributions (users vs. time) * Fix spanish typos Co-authored-by: Wonjang Son <sondaniel.88@gmail.com> * Fix korean typos Co-authored-by: Wonjang Son <sondaniel.88@gmail.com> * New strings translated to `ar` Arabic Co-authored-by: أحمد الطبراني <eltabaraniahmed@gmail.com> * New strings translated to `fr` French Co-authored-by: Loic Beylot <loic.beylot@gmail.com> Co-authored-by: أحمد الطبراني <eltabaraniahmed@gmail.com> Co-authored-by: ImVector <59611597+LuigiImVector@users.noreply.github.com> Co-authored-by: Wonjang Son <sondaniel.88@gmail.com> Co-authored-by: Loic Beylot <loic.beylot@gmail.com>
2022-02-28 17:04:55 +01:00
</div>
**Welcome to `Free-Programming-Books`!**
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:
* [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)
* [Creating a pull request](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/creating-a-pull-request)
* [GitHub Hello World](https://docs.github.com/en/get-started/quickstart/hello-world)
* [YouTube - GitHub Tutorial For Beginners](https://www.youtube.com/watch?v=0fKg7e37bQE)
* [YouTube - How To Fork A GitHub Repo and Submit A Pull Request](https://www.youtube.com/watch?v=G1I3HF4YWEw)
* [YouTube - Markdown Crash Course](https://www.youtube.com/watch?v=HUBNt18RFbo)
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.
<details align="center" markdown="1">
<summary>Click to see users vs. time graphs.</summary>
How to (#2783) * add HOWTO for new contibutors, edit documentation * edit * add resource titles and delint
2018-04-06 16:01:46 +02:00
docs(howto): Homogenize HowTo's format across translated files (#6724) * 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 EbookFoundation/free-programming-books#6590 * Rewording to be more meaningful * Add H1 header + `Read this` ... aligned to right Via EbookFoundation/free-programming-books#6590 * remove trailing spaces * Split a bit first paragraph to highlight welcome. Via EbookFoundation/free-programming-books#6590 * homogenize `1-2` newlines amount between paragraphs * Update Github documentation links list - Update GitHub links urls. `help`/`guides` subdomain was moved to `docs` so now a 301 Redirect is skipped. - Remove flag emojis from link, perhaps use text in notes format to give accesibility locale context Via EbookFoundation/free-programming-books#6590 * GitHub trademark typos * YouTube trademark typos * `Welcome to fpb!` in bold style * Repo name backticked in monospace font (non-translatable) * reword es-en graph summary * Add a centered details block with graphs about contributions (users vs. time) Detail blocks are toggleable sections in GitHub Provided graphs by apiseven: - Contributor over time Graph - Monthly Active Contributors graph * GitHub trademark typos * Fix pull request typos and introduce it acronym * Update Github documentation links list - Update GitHub links urls. `help`/`guides` subdomain was moved to `docs` so now a 301 Redirect is skipped. - Remove flag emojis from link, perhaps use text in notes format to give accesibility locale context The forgot rest addressed on 7ee485bb3b1f16cd58aa4aacef3f8af19fb588ea commit Via EbookFoundation/free-programming-books#6590 * Some bolds to highlight common resources formating issues (like in CONTRIBUTING) * Fix typos suggested by AhmedElTabarani Co-authored-by: أحمد الطبراني <eltabaraniahmed@gmail.com> * Add paragrah from #5351. Need language translation * New strings translated to `it` Italian Co-authored-by: ImVector <59611597+LuigiImVector@users.noreply.github.com> * use languages not countries. `in Egyptian Arabic` * use languages not countries. `in Algerian Arabic` * remove notes from details block containing graphs about contributions (users vs. time) * Fix spanish typos Co-authored-by: Wonjang Son <sondaniel.88@gmail.com> * Fix korean typos Co-authored-by: Wonjang Son <sondaniel.88@gmail.com> * New strings translated to `ar` Arabic Co-authored-by: أحمد الطبراني <eltabaraniahmed@gmail.com> * New strings translated to `fr` French Co-authored-by: Loic Beylot <loic.beylot@gmail.com> Co-authored-by: أحمد الطبراني <eltabaraniahmed@gmail.com> Co-authored-by: ImVector <59611597+LuigiImVector@users.noreply.github.com> Co-authored-by: Wonjang Son <sondaniel.88@gmail.com> Co-authored-by: Loic Beylot <loic.beylot@gmail.com>
2022-02-28 17:04:55 +01:00
[![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)
How to (#2783) * add HOWTO for new contibutors, edit documentation * edit * add resource titles and delint
2018-04-06 16:01:46 +02:00
docs(howto): Homogenize HowTo's format across translated files (#6724) * 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 EbookFoundation/free-programming-books#6590 * Rewording to be more meaningful * Add H1 header + `Read this` ... aligned to right Via EbookFoundation/free-programming-books#6590 * remove trailing spaces * Split a bit first paragraph to highlight welcome. Via EbookFoundation/free-programming-books#6590 * homogenize `1-2` newlines amount between paragraphs * Update Github documentation links list - Update GitHub links urls. `help`/`guides` subdomain was moved to `docs` so now a 301 Redirect is skipped. - Remove flag emojis from link, perhaps use text in notes format to give accesibility locale context Via EbookFoundation/free-programming-books#6590 * GitHub trademark typos * YouTube trademark typos * `Welcome to fpb!` in bold style * Repo name backticked in monospace font (non-translatable) * reword es-en graph summary * Add a centered details block with graphs about contributions (users vs. time) Detail blocks are toggleable sections in GitHub Provided graphs by apiseven: - Contributor over time Graph - Monthly Active Contributors graph * GitHub trademark typos * Fix pull request typos and introduce it acronym * Update Github documentation links list - Update GitHub links urls. `help`/`guides` subdomain was moved to `docs` so now a 301 Redirect is skipped. - Remove flag emojis from link, perhaps use text in notes format to give accesibility locale context The forgot rest addressed on 7ee485bb3b1f16cd58aa4aacef3f8af19fb588ea commit Via EbookFoundation/free-programming-books#6590 * Some bolds to highlight common resources formating issues (like in CONTRIBUTING) * Fix typos suggested by AhmedElTabarani Co-authored-by: أحمد الطبراني <eltabaraniahmed@gmail.com> * Add paragrah from #5351. Need language translation * New strings translated to `it` Italian Co-authored-by: ImVector <59611597+LuigiImVector@users.noreply.github.com> * use languages not countries. `in Egyptian Arabic` * use languages not countries. `in Algerian Arabic` * remove notes from details block containing graphs about contributions (users vs. time) * Fix spanish typos Co-authored-by: Wonjang Son <sondaniel.88@gmail.com> * Fix korean typos Co-authored-by: Wonjang Son <sondaniel.88@gmail.com> * New strings translated to `ar` Arabic Co-authored-by: أحمد الطبراني <eltabaraniahmed@gmail.com> * New strings translated to `fr` French Co-authored-by: Loic Beylot <loic.beylot@gmail.com> Co-authored-by: أحمد الطبراني <eltabaraniahmed@gmail.com> Co-authored-by: ImVector <59611597+LuigiImVector@users.noreply.github.com> Co-authored-by: Wonjang Son <sondaniel.88@gmail.com> Co-authored-by: Loic Beylot <loic.beylot@gmail.com>
2022-02-28 17:04:55 +01:00
[![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)
How to (#2783) * add HOWTO for new contibutors, edit documentation * edit * add resource titles and delint
2018-04-06 16:01:46 +02:00
docs(howto): Homogenize HowTo's format across translated files (#6724) * 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 EbookFoundation/free-programming-books#6590 * Rewording to be more meaningful * Add H1 header + `Read this` ... aligned to right Via EbookFoundation/free-programming-books#6590 * remove trailing spaces * Split a bit first paragraph to highlight welcome. Via EbookFoundation/free-programming-books#6590 * homogenize `1-2` newlines amount between paragraphs * Update Github documentation links list - Update GitHub links urls. `help`/`guides` subdomain was moved to `docs` so now a 301 Redirect is skipped. - Remove flag emojis from link, perhaps use text in notes format to give accesibility locale context Via EbookFoundation/free-programming-books#6590 * GitHub trademark typos * YouTube trademark typos * `Welcome to fpb!` in bold style * Repo name backticked in monospace font (non-translatable) * reword es-en graph summary * Add a centered details block with graphs about contributions (users vs. time) Detail blocks are toggleable sections in GitHub Provided graphs by apiseven: - Contributor over time Graph - Monthly Active Contributors graph * GitHub trademark typos * Fix pull request typos and introduce it acronym * Update Github documentation links list - Update GitHub links urls. `help`/`guides` subdomain was moved to `docs` so now a 301 Redirect is skipped. - Remove flag emojis from link, perhaps use text in notes format to give accesibility locale context The forgot rest addressed on 7ee485bb3b1f16cd58aa4aacef3f8af19fb588ea commit Via EbookFoundation/free-programming-books#6590 * Some bolds to highlight common resources formating issues (like in CONTRIBUTING) * Fix typos suggested by AhmedElTabarani Co-authored-by: أحمد الطبراني <eltabaraniahmed@gmail.com> * Add paragrah from #5351. Need language translation * New strings translated to `it` Italian Co-authored-by: ImVector <59611597+LuigiImVector@users.noreply.github.com> * use languages not countries. `in Egyptian Arabic` * use languages not countries. `in Algerian Arabic` * remove notes from details block containing graphs about contributions (users vs. time) * Fix spanish typos Co-authored-by: Wonjang Son <sondaniel.88@gmail.com> * Fix korean typos Co-authored-by: Wonjang Son <sondaniel.88@gmail.com> * New strings translated to `ar` Arabic Co-authored-by: أحمد الطبراني <eltabaraniahmed@gmail.com> * New strings translated to `fr` French Co-authored-by: Loic Beylot <loic.beylot@gmail.com> Co-authored-by: أحمد الطبراني <eltabaraniahmed@gmail.com> Co-authored-by: ImVector <59611597+LuigiImVector@users.noreply.github.com> Co-authored-by: Wonjang Son <sondaniel.88@gmail.com> Co-authored-by: Loic Beylot <loic.beylot@gmail.com>
2022-02-28 17:04:55 +01:00
</details>
How to (#2783) * add HOWTO for new contibutors, edit documentation * edit * add resource titles and delint
2018-04-06 16:01:46 +02:00
docs(howto): Homogenize HowTo's format across translated files (#6724) * 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 EbookFoundation/free-programming-books#6590 * Rewording to be more meaningful * Add H1 header + `Read this` ... aligned to right Via EbookFoundation/free-programming-books#6590 * remove trailing spaces * Split a bit first paragraph to highlight welcome. Via EbookFoundation/free-programming-books#6590 * homogenize `1-2` newlines amount between paragraphs * Update Github documentation links list - Update GitHub links urls. `help`/`guides` subdomain was moved to `docs` so now a 301 Redirect is skipped. - Remove flag emojis from link, perhaps use text in notes format to give accesibility locale context Via EbookFoundation/free-programming-books#6590 * GitHub trademark typos * YouTube trademark typos * `Welcome to fpb!` in bold style * Repo name backticked in monospace font (non-translatable) * reword es-en graph summary * Add a centered details block with graphs about contributions (users vs. time) Detail blocks are toggleable sections in GitHub Provided graphs by apiseven: - Contributor over time Graph - Monthly Active Contributors graph * GitHub trademark typos * Fix pull request typos and introduce it acronym * Update Github documentation links list - Update GitHub links urls. `help`/`guides` subdomain was moved to `docs` so now a 301 Redirect is skipped. - Remove flag emojis from link, perhaps use text in notes format to give accesibility locale context The forgot rest addressed on 7ee485bb3b1f16cd58aa4aacef3f8af19fb588ea commit Via EbookFoundation/free-programming-books#6590 * Some bolds to highlight common resources formating issues (like in CONTRIBUTING) * Fix typos suggested by AhmedElTabarani Co-authored-by: أحمد الطبراني <eltabaraniahmed@gmail.com> * Add paragrah from #5351. Need language translation * New strings translated to `it` Italian Co-authored-by: ImVector <59611597+LuigiImVector@users.noreply.github.com> * use languages not countries. `in Egyptian Arabic` * use languages not countries. `in Algerian Arabic` * remove notes from details block containing graphs about contributions (users vs. time) * Fix spanish typos Co-authored-by: Wonjang Son <sondaniel.88@gmail.com> * Fix korean typos Co-authored-by: Wonjang Son <sondaniel.88@gmail.com> * New strings translated to `ar` Arabic Co-authored-by: أحمد الطبراني <eltabaraniahmed@gmail.com> * New strings translated to `fr` French Co-authored-by: Loic Beylot <loic.beylot@gmail.com> Co-authored-by: أحمد الطبراني <eltabaraniahmed@gmail.com> Co-authored-by: ImVector <59611597+LuigiImVector@users.noreply.github.com> Co-authored-by: Wonjang Son <sondaniel.88@gmail.com> Co-authored-by: Loic Beylot <loic.beylot@gmail.com>
2022-02-28 17:04:55 +01:00
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.
How to (#2783) * add HOWTO for new contibutors, edit documentation * edit * add resource titles and delint
2018-04-06 16:01:46 +02:00
docs(howto): Homogenize HowTo's format across translated files (#6724) * 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 EbookFoundation/free-programming-books#6590 * Rewording to be more meaningful * Add H1 header + `Read this` ... aligned to right Via EbookFoundation/free-programming-books#6590 * remove trailing spaces * Split a bit first paragraph to highlight welcome. Via EbookFoundation/free-programming-books#6590 * homogenize `1-2` newlines amount between paragraphs * Update Github documentation links list - Update GitHub links urls. `help`/`guides` subdomain was moved to `docs` so now a 301 Redirect is skipped. - Remove flag emojis from link, perhaps use text in notes format to give accesibility locale context Via EbookFoundation/free-programming-books#6590 * GitHub trademark typos * YouTube trademark typos * `Welcome to fpb!` in bold style * Repo name backticked in monospace font (non-translatable) * reword es-en graph summary * Add a centered details block with graphs about contributions (users vs. time) Detail blocks are toggleable sections in GitHub Provided graphs by apiseven: - Contributor over time Graph - Monthly Active Contributors graph * GitHub trademark typos * Fix pull request typos and introduce it acronym * Update Github documentation links list - Update GitHub links urls. `help`/`guides` subdomain was moved to `docs` so now a 301 Redirect is skipped. - Remove flag emojis from link, perhaps use text in notes format to give accesibility locale context The forgot rest addressed on 7ee485bb3b1f16cd58aa4aacef3f8af19fb588ea commit Via EbookFoundation/free-programming-books#6590 * Some bolds to highlight common resources formating issues (like in CONTRIBUTING) * Fix typos suggested by AhmedElTabarani Co-authored-by: أحمد الطبراني <eltabaraniahmed@gmail.com> * Add paragrah from #5351. Need language translation * New strings translated to `it` Italian Co-authored-by: ImVector <59611597+LuigiImVector@users.noreply.github.com> * use languages not countries. `in Egyptian Arabic` * use languages not countries. `in Algerian Arabic` * remove notes from details block containing graphs about contributions (users vs. time) * Fix spanish typos Co-authored-by: Wonjang Son <sondaniel.88@gmail.com> * Fix korean typos Co-authored-by: Wonjang Son <sondaniel.88@gmail.com> * New strings translated to `ar` Arabic Co-authored-by: أحمد الطبراني <eltabaraniahmed@gmail.com> * New strings translated to `fr` French Co-authored-by: Loic Beylot <loic.beylot@gmail.com> Co-authored-by: أحمد الطبراني <eltabaraniahmed@gmail.com> Co-authored-by: ImVector <59611597+LuigiImVector@users.noreply.github.com> Co-authored-by: Wonjang Son <sondaniel.88@gmail.com> Co-authored-by: Loic Beylot <loic.beylot@gmail.com>
2022-02-28 17:04:55 +01:00
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)*.