mirror of
https://github.com/dariubs/GoBooks.git
synced 2026-04-30 14:03:54 +07:00
2997e056e5
ref #163
1.8 KiB
1.8 KiB
Contribution Guidelines
Adding a book to the main list
Add books with this format:
### DATE - [BOOK NAME](BOOK URL)
<img src="gobooks/covers/COVER_FILENAME" width="120px"/>
BOOK DESCRIPTION
- Place cover images in
gobooks/covers/with a slug filename (e.g.book-name.jpg). - If book is free, add it after free books of that category and also add
*Free*after book url. - Add other books in ascending date order (newest last). Books without date go at the end of the list in that category.
- To keep track of the huge table of contents you can use a plugin like Markdown VSCode plugin
Adding a book in another language
If a Go book exists in a language that already has a page (gobooks/README-<lang>.md), add it to that file using the same format as the main list. Write the book description in that language. Cover images go in gobooks/covers/ as usual.
Adding a new language
If no page exists yet for a language:
- Create
gobooks/README-<lang>.mdusing the ISO 639-1 language code (e.g.README-ja.mdfor Japanese). - Use the title Go Books translated into that language as the page heading (e.g.
# Go ブックス). - Write the introductory description in that language. Keep it simple: state that this is a complete list of Go books available in that language.
- List books using the same card format as the main README. All descriptions must be written in that language.
- For right-to-left languages (Arabic, Farsi, Hebrew, etc.), wrap the entire content in
<div dir="rtl"> ... </div>. - Add a link to the new page in the language bar at the top of
README.md:**Other languages:** ... · [Language name in its own script](gobooks/README-<lang>.md)