Skip to content

Commit f9140df

Browse files
authored
* add HOWTO for new contibutors, edit documentation * edit * add resource titles and delint
1 parent 0e15ed0 commit f9140df

File tree

3 files changed

+17
-4
lines changed

3 files changed

+17
-4
lines changed

CONTRIBUTING.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -11,9 +11,9 @@ By contributing you agree to respect the [Code of Conduct](https://github.com/Eb
1111
3. We have 5 kinds of lists. Choose the right one:
1212

1313
- *Books* : PDF, HTML, ePub, a gitbook.io based site, a Git repo, etc.
14-
- *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/).
14+
- *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/).
1515
- *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).
16-
- *JavaScript Resources* : Any resources teaching a JavaScript framework or library.
16+
- *Podcasts and Screencasts* : Podcasts and screencasts.
1717
- *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.
1818

1919
4. Make sure to follow the [guidelines below](#guidelines) and respect the [Markdown formatting](#formatting) of the files

HOWTO.md

+13
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
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:
2+
3+
* [About Pull Requests](https://help.github.com/articles/about-pull-requests/)
4+
* [Github Hello World](https://guides.github.com/activities/hello-world/)
5+
* [Youtube - Github Tutorial For Beginners](https://www.youtube.com/watch?v=0fKg7e37bQE)
6+
* [Youtube - How To Fork A GitHub Repo and Submit A Pull Request](https://www.youtube.com/watch?v=G1I3HF4YWEw)
7+
8+
9+
Don't hesitate to ask questions; every contributor started with a first PR. You could be our thousandth!
10+
11+
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 or 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.
12+
13+
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).

README.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ The repo is now administered by the [Free Ebook Foundation](https://ebookfoundat
1111

1212
### How To Contribute
1313

14-
Please read [CONTRIBUTING](/CONTRIBUTING.md).
14+
Please read [CONTRIBUTING](/CONTRIBUTING.md). If you're new to Github, [welcome](/HOWTO.md)!
1515

1616
### How to Share
1717
+ [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).
2020
+ [Share on LinkedIn](http://www.linkedin.com/shareArticle?mini=true&url=https://github.com/EbookFoundation/free-programming-books&title=Free%20Programming%20Books&summary=&source=)
2121

2222

23-
### In Other Spoken Languages
23+
### In Other Written Languages
2424
+ [Arabic](/free-programming-books-ar.md)
2525
+ [Azerbaijani](/free-programming-books-az.md)
2626
+ [Bengali](/free-programming-books-bl.md)

0 commit comments

Comments
 (0)