CONTRIBUTING.md 3.5 KB
Newer Older
1 2 3 4 5 6
# Contribute to the lists
Hello dear friend, welcome!
This guide details how to contribute to this repository.


## Contributor license agreement
7
By submitting code you agree to the [LICENSE](https://github.com/vhf/free-programming-books/blob/master/LICENSE) of this repository.
8 9


10 11 12
## All the steps you need
1. First of all, what you want to add should be actually 'Free'. Don't mistake "An easy link to Download a book" with "Free".
2. If you don't know how to work with git or github, just simply go to [Wiki: Contribution](https://github.com/vhf/free-programming-books/wiki/Contribution) and read the rest.
V
victor felder 已提交
13
3. We have 5 kinds of lists. Make sure you know where you're adding the link:
14 15 16 17
    
    + **Books** : PDF, HTML, DJVU, ePub, a gitBook.io based site, a Git repo, etc.
    + **Courses** : A course is a well designed learning material which was made by an organized group and is availabe for a long time where there is no interactive tool embeded in the site. e.g.: [OpenCourseWare](http://ocw.mit.edu/), [PHPAcademy](https://phpacademy.org), etc.
    + **Interactive Tutorials** : An application which helps you learn, by actually typing syntax. e.g.: [Codecademy](http://www.codecademy.com/), [Try Github](http://try.github.io/), etc.
S
switchhax 已提交
18 19
    + **Javascript Resources** : Resources for learning a Javascript Framework
    + **Problem Sets & Competetitive Programming** : Challenges/problems, where you can prove your programming skills for yourself or against others
20

21 22
4. We prefer small commits rather than one large commit in a pull request. If you don't have the time to make small commit, add an issue with all the links included and we'll add them for you.
5. Use our standard for formatting the .md file. Check it out: [Formatting](#formatting)
F
Fwiffo 已提交
23
6. Must use ***alphabetic*** order.
24 25 26


### Formatting
M
Mohammad Hossein Mojtahedi 已提交
27
+ All lists are `.md` files. Try to learn Github's Markdown syntax. It's simple!
28
+ All the lists start with an Index, the idea is to show all of sections and subsections there, so it's important to have an index for each section. Right now it's alphabetized, so please use alphabetic order.
M
Mohammad Hossein Mojtahedi 已提交
29
+ Sections are using level 3 heading (in HTML is `<h3>`, in Markdown is `###`), and subsections are using level 4 (in HTML is `<h4>`, in Markdown is `####`).
30 31

The idea is to have
M
Mohammad Hossein Mojtahedi 已提交
32
+ `2` empty lines between last suggested book & new header
V
victor felder 已提交
33
+ `1` empty line between header & first book of that very section.
M
Mohammad Hossein Mojtahedi 已提交
34 35
+ `0` empty line between each book in 1 section.
+ `1` empty line at the end of each `.md` file.
36 37

Like this example:
M
Mohammad Hossein Mojtahedi 已提交
38
```markdown
39 40 41 42
[...]
* [Essential Pascal Version 1 and 2](http://www.marcocantu.com/epascal/)


C
Christoph Uschkrat 已提交
43
### DTrace
V
victor felder 已提交
44

45 46 47
* [IllumOS Dynamic Tracing Guide](http://dtrace.org/guide/preface.html)
* [Some Other Book](http://so.me/other/book.html)

48 49 50 51 52
BAD : * [IllumOS Dynamic Tracing Guide](http://dtrace.org/guide/preface.html)(PDF)
GOOD: * [IllumOS Dynamic Tracing Guide](http://dtrace.org/guide/preface.html) (PDF)

BAD : * [IllumOS Dynamic Tracing Guide](http://dtrace.org/guide/preface.html)- Robert
GOOD: * [IllumOS Dynamic Tracing Guide](http://dtrace.org/guide/preface.html) - Robert
53

54 55
```

F
Fwiffo 已提交
56 57 58 59
#### What to do about multiple links to the same book ([#1192](https://github.com/vhf/free-programming-books/issues/1192#issuecomment-135969100))
+ if its a different edition, add separate link with a note about its edition
+ if its the same book but in a better format, replace link
+ if one is a webpage and the other is pdf, add separate link with a note about its format
60

61 62
And that's it! Simple, easy and lovely...

B
borgified 已提交
63
We hope you contribute to this great repository. :+1: