mirror of
https://github.com/EbookFoundation/free-programming-books.git
synced 2025-02-20 07:54:46 +01:00
28ec79103b
* 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>
35 lines
2.7 KiB
Markdown
35 lines
2.7 KiB
Markdown
# How-To at a glance
|
|
|
|
<div align="right" markdown="1">
|
|
|
|
*[Read this in other languages](README.md#translations)*
|
|
|
|
</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>
|
|
|
|
[](https://www.apiseven.com/en/contributor-graph?chart=contributorOverTime&repo=ebookfoundation/free-programming-books)
|
|
|
|
[](https://www.apiseven.com/en/contributor-graph?chart=contributorMonthlyActivity&repo=ebookfoundation/free-programming-books)
|
|
|
|
</details>
|
|
|
|
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.
|
|
|
|
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)*.
|