From b64049f91153c99b8450100bf0ac06a29547cc6d Mon Sep 17 00:00:00 2001 From: eric Date: Fri, 30 Mar 2018 09:58:17 -0400 Subject: [PATCH] add HOWTO for new contibutors, edit documentation --- CONTRIBUTING.md | 4 ++-- HOWTO.md | 12 ++++++++++++ README.md | 4 ++-- 3 files changed, 16 insertions(+), 4 deletions(-) create mode 100644 HOWTO.md diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 70ee1ad5..9697ab2a 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -11,9 +11,9 @@ By contributing you agree to respect the [Code of Conduct](https://github.com/Eb 3. We have 5 kinds of lists. Choose the right one: - *Books* : PDF, HTML, ePub, a gitbook.io based site, a Git repo, etc. - - *Courses* : A course is a learning material which is not a book and where there is no interactive tool embedded in the site. [This is a course](http://ocw.mit.edu/courses/electrical-engineering-and-computer-science/6-006-introduction-to-algorithms-fall-2011/). + - *Courses* : A course is a learning material which is not a book. [This is a course](http://ocw.mit.edu/courses/electrical-engineering-and-computer-science/6-006-introduction-to-algorithms-fall-2011/). - *Interactive Tutorials* : An interactive website which lets the user type code or commands and evaluates the result (by "evaluate" we don't mean "grade"). e.g.: [Try Haskell](http://tryhaskell.org), [Try Github](http://try.github.io). - - *JavaScript Resources* : Any resources teaching a JavaScript framework or library. + - *Podcasts and Screencasts* : Podcasts and screencasts. - *Problem Sets & Competitive Programming* : A website or software which lets you assess your programming skills by solving simple or complex problems, with or without code review, with or without comparing the results with other users. 4. Make sure to follow the [guidelines below](#guidelines) and respect the [Markdown formatting](#formatting) of the files diff --git a/HOWTO.md b/HOWTO.md new file mode 100644 index 00000000..ae6719e3 --- /dev/null +++ b/HOWTO.md @@ -0,0 +1,12 @@ +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: + +- https://www.youtube.com/watch?v=0fKg7e37bQE +- https://www.youtube.com/watch?v=G1I3HF4YWEw +- https://guides.github.com/activities/hello-world/ +- https://help.github.com/articles/about-pull-requests/ + +Don't hesitate to ask questions; every contributor started with a first PR. You could be our thousandth! + +Even if you're an experienced open source contributor, there are things that might trip you up. Once you've submitted your PR, Travis-CI will run a linter, often finding little issues with spacing an alphabetization. If you get a green button, everything is ready for review, but if not, click on the travis link to find out what the linter didn't like. Fix the problem and add a commit to your PR. + +Finally, read through the guidelines in [CONTRIBUTING](/CONTRIBUTING.md) if you're not sure if the resource you want to add is appropriate for Free-Programming-Books. diff --git a/README.md b/README.md index e8691c7b..3e6e0893 100644 --- a/README.md +++ b/README.md @@ -11,7 +11,7 @@ The repo is now administered by the [Free Ebook Foundation](https://ebookfoundat ### How To Contribute -Please read [CONTRIBUTING](/CONTRIBUTING.md). +Please read [CONTRIBUTING](/CONTRIBUTING.md). If you're new to Github, [welcome](/HOWTO.md)! ### How to Share + [Share on Twitter](http://twitter.com/home?status=https://github.com/EbookFoundation/free-programming-books%0AFree%20Programming%20Books) @@ -20,7 +20,7 @@ Please read [CONTRIBUTING](/CONTRIBUTING.md). + [Share on LinkedIn](http://www.linkedin.com/shareArticle?mini=true&url=https://github.com/EbookFoundation/free-programming-books&title=Free%20Programming%20Books&summary=&source=) -### In Other Spoken Languages +### In Other Written Languages + [Arabic](/free-programming-books-ar.md) + [Azerbaijani](/free-programming-books-az.md) + [Bengali](/free-programming-books-bl.md) -- GitLab