0ee043dc9a
- 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
2.7 KiB
How-To at a glance
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
- Creating a Pull Requests
- GitHub Hello World
- YouTube - GitHub Tutorial For Beginners
- YouTube - How To Fork A GitHub Repo and Submit A Pull Request
- YouTube - Markdown Crash Course
Don't hesitate to ask questions; every contributor started with a first PR. So... why not join our large, growing community.
Details about that growth
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 (translations also available).