mirror of
https://github.com/EbookFoundation/free-programming-books.git
synced 2024-12-21 10:56:13 +00:00
49 lines
2.0 KiB
Markdown
49 lines
2.0 KiB
Markdown
|
# Contribute to the lists
|
||
|
|
Hello dear friend, welcome!
|
||
|
|
This guide details how to contribute to this repository.
|
||
|
|
|
||
|
|
|
||
|
|
## Contributor license agreement
|
||
|
|
By submitting code you agree to the [LICENCE](/LICENSE) of this repository.
|
||
|
|
|
||
|
|
|
||
|
|
## Everyone is welcome to add a new free book to the list
|
||
|
|
Yep, that is true, you and your friends are welcome to add new free books to the list. And by free, we mean free, really free.
|
||
|
|
And you know what? It's really easy, see below.
|
||
|
|
|
||
|
|
|
||
|
|
## Steps to add a new book
|
||
|
|
Make sure that you've read [Contribution](https://github.com/vhf/free-programming-books/wiki/Contribution), which guides you to editing a repository. Then:
|
||
|
|
|
||
|
|
1. Again, unlike other projects, we prefer multiple small commits rather than one large change in a pull request - it's fine to have one pull request, but please make sure your title reflects what you've changed.
|
||
|
|
2. Use our standard for formatting the .md file. Check it out: [Formatting](#formatting)
|
||
|
|
3. Please try to use alphabetic order.
|
||
|
|
|
||
|
|
|
||
|
|
### Formatting
|
||
|
|
We are adults. Let's respect the next standard.
|
||
|
|
+ All lists are ```.md``` files. Try to learn Github's Markdown syntax. It's simple!
|
||
|
|
+ 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.
|
||
|
|
+ Sections are using level 3 heading (in HTML is ```<h3>```, in Markdown is ```###```), and subsections are using level 4 (in Markdown is ####).
|
||
|
|
|
||
|
|
The idea is to have
|
||
|
|
+ ```2``` empty lines between last suggested book & header
|
||
|
|
+ ```0``` empty line between header & first book of that very section.
|
||
|
|
+ ```0``` empty line between each book in 1 section.
|
||
|
|
+ ```1``` empty line at the end of each ```.md``` file.
|
||
|
|
|
||
|
|
Like this example:
|
||
|
|
```
|
||
|
|
[...]
|
||
|
|
* [Essential Pascal Version 1 and 2](http://www.marcocantu.com/epascal/)
|
||
|
|
|
||
|
|
|
||
|
|
###DTrace
|
||
|
|
* [IllumOS Dynamic Tracing Guide](http://dtrace.org/guide/preface.html)
|
||
|
|
* [Some Other Book](http://so.me/other/book.html)
|
||
|
|
|
||
|
|
```
|
||
|
|
|
||
|
|
And that's it! Simple, easy and lovely...
|
||
|
|
|
||
|
|
We hope you contribute to this great repository. :+1:
|