ch0ic3/free-programming-books
1
0
Fork 0
mirror of https://github.com/EbookFoundation/free-programming-books.git synced 2024-12-21 02:46:13 +00:00
Code Issues Actions 2 Packages Projects Releases Wiki Activity
ab0a43e19c
free-programming-books/docs/HOWTO.md

35 lines
2.7 KiB
Markdown
Raw Normal View History

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
2022-02-15 08:36:26 +00:00
# How-To at a glance
<div align="right" markdown="1">
move the translated documentation files to a docs folder (#6614) * new branch for misc cleanup * add item to resolve #6319 * fix grammar * re-collate * centralize all the translation links * one more * fix link * localize labels * move files * fix links * indent in arabic Co-authored-by: David Ordás <3125580+davorpa@users.noreply.github.com> * typos Co-authored-by: David Ordás <3125580+davorpa@users.noreply.github.com> * remove Co-authored-by: David Ordás <3125580+davorpa@users.noreply.github.com> * translation Co-authored-by: David Ordás <3125580+davorpa@users.noreply.github.com> * translation Co-authored-by: David Ordás <3125580+davorpa@users.noreply.github.com> * mixed markdown Co-authored-by: David Ordás <3125580+davorpa@users.noreply.github.com> * period Co-authored-by: David Ordás <3125580+davorpa@users.noreply.github.com> * missing * Co-authored-by: David Ordás <3125580+davorpa@users.noreply.github.com> * Update docs/HOWTO-pl.md Co-authored-by: David Ordás <3125580+davorpa@users.noreply.github.com> * Update docs/HOWTO-th.md Co-authored-by: David Ordás <3125580+davorpa@users.noreply.github.com> * translated Co-authored-by: David Ordás <3125580+davorpa@users.noreply.github.com> * translate Co-authored-by: David Ordás <3125580+davorpa@users.noreply.github.com> * lower case Co-authored-by: David Ordás <3125580+davorpa@users.noreply.github.com> * typo Co-authored-by: David Ordás <3125580+davorpa@users.noreply.github.com> * wording Co-authored-by: David Ordás <3125580+davorpa@users.noreply.github.com> * translations link Co-authored-by: David Ordás <3125580+davorpa@users.noreply.github.com> * space Co-authored-by: David Ordás <3125580+davorpa@users.noreply.github.com> * space Co-authored-by: David Ordás <3125580+davorpa@users.noreply.github.com> * typo Co-authored-by: David Ordás <3125580+davorpa@users.noreply.github.com> * fix link Co-authored-by: David Ordás <3125580+davorpa@users.noreply.github.com> * fix link Co-authored-by: David Ordás <3125580+davorpa@users.noreply.github.com> * Update CONTRIBUTING-de.md * space Co-authored-by: David Ordás <3125580+davorpa@users.noreply.github.com> * fix link Co-authored-by: David Ordás <3125580+davorpa@users.noreply.github.com> * fix link Co-authored-by: David Ordás <3125580+davorpa@users.noreply.github.com> * parens not brackets * fix link Co-authored-by: David Ordás <3125580+davorpa@users.noreply.github.com> * fix link Co-authored-by: David Ordás <3125580+davorpa@users.noreply.github.com> * add #6619 * chore: resolve dead code CONTRIB-es Addressed at https://github.com/EbookFoundation/free-programming-books/pull/6614#commitcomment-60517997 Review suggestion: https://github.com/EbookFoundation/free-programming-books/pull/6614#discussion_r751697277 * chore: use spanish translated text for "translations" Review suggestion: https://github.com/EbookFoundation/free-programming-books/pull/6614#discussion_r751697277 * chore: DRY. Use markdown link refs as translations target Review suggestion: https://github.com/EbookFoundation/free-programming-books/pull/6614#discussion_r751697277 * fix: revert removed parens in previous commit 6276a21d85c963b159b9ca9a02a7f863b1bccc39 Review suggestion: https://github.com/EbookFoundation/free-programming-books/pull/6614#discussion_r751697277 * fix link Co-authored-by: David Ordás <3125580+davorpa@users.noreply.github.com> * lint Co-authored-by: David Ordás <3125580+davorpa@users.noreply.github.com> * fix link Co-authored-by: David Ordás <3125580+davorpa@users.noreply.github.com> * lint Co-authored-by: David Ordás <3125580+davorpa@users.noreply.github.com> * lint Co-authored-by: David Ordás <3125580+davorpa@users.noreply.github.com> * fix link Co-authored-by: David Ordás <3125580+davorpa@users.noreply.github.com> * lint Co-authored-by: David Ordás <3125580+davorpa@users.noreply.github.com> * fix link Co-authored-by: David Ordás <3125580+davorpa@users.noreply.github.com> * fix link Co-authored-by: David Ordás <3125580+davorpa@users.noreply.github.com> * space Co-authored-by: David Ordás <3125580+davorpa@users.noreply.github.com> * translate Co-authored-by: David Ordás <3125580+davorpa@users.noreply.github.com> Co-authored-by: David Ordás <3125580+davorpa@users.noreply.github.com>
2021-11-20 18:25:15 +00: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 13:57:57 +00:00
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
2022-02-15 08:36:26 +00: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 Requests](https://docs.github.com/en/free-pro-team@latest/github/collaborating-with-issues-and-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">
Rewording to be more meaningful
2022-02-16 06:46:48 +00:00
<summary>Click to see graph details about that growth</summary>
How to (#2783) * add HOWTO for new contibutors, edit documentation * edit * add resource titles and delint
2018-04-06 14:01:46 +00:00
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
2022-02-15 08:36:26 +00: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 14:01:46 +00:00
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
2022-02-15 08:36:26 +00: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 14:01:46 +00:00
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
2022-02-15 08:36:26 +00:00
</details>
How to (#2783) * add HOWTO for new contibutors, edit documentation * edit * add resource titles and delint
2018-04-06 14:01:46 +00:00
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
2022-02-15 08:36:26 +00: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 14:01:46 +00:00
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
2022-02-15 08:36:26 +00: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)*.
Reference in New Issue Copy Permalink