Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs(contributing): Homogenize format across translated files #6625

Merged
Merged
Changes from 1 commit
Commits
Show all changes
43 commits
Select commit Hold shift + click to select a range
510c268
docs(contributing): remove trailing spaces
davorpa Nov 4, 2021
e83220a
docs(contributing): Apply headings `2-1` empty lines lint rule
davorpa Nov 4, 2021
c0121b8
docs(contributing): Apply headings `2-1` empty lines lint rule
davorpa Nov 4, 2021
6c8d900
docs(contributing): Move anchor alias to inside list items
davorpa Nov 4, 2021
780cd6d
docs(contributing): Homogenize `1` blank line in nutshell enumeration
davorpa Nov 4, 2021
4d58f16
docs(contributing): Homogenize `1` blank line inside Formatting section
davorpa Nov 4, 2021
31c776c
docs(contributing): Ensure `4-spaces` indent `.editorconfig` param
davorpa Nov 4, 2021
f9dc719
docs(contributing): Homogenize format & indent of code blocks
davorpa Nov 4, 2021
f7905f9
docs(contributing): Ensure `4-spaces` indent `.editorconfig` param
davorpa Nov 4, 2021
a2d758b
docs(contributing): Homogenize format & indent of code blocks
davorpa Nov 4, 2021
0333e20
docs(contributing): Use "consistent" unordered list mark
davorpa Nov 5, 2021
50e4f77
docs(contributing): Solve `no-space-in-*` lint rules
davorpa Nov 5, 2021
0b6db6a
docs(contributing): Move some punctuation just before any closing bra…
davorpa Nov 5, 2021
0d97b01
docs(contributing): Hack highlight IDE/Editors headings+HTML
davorpa Nov 5, 2021
c803924
docs(contributing): Homogenize Pull Request acronym
davorpa Nov 9, 2021
bb7e9fe
docs(contributing): Fix `GitHub` trademark typos
davorpa Nov 9, 2021
6b6ada5
docs(contributing): ALLCAPS
davorpa Nov 9, 2021
1899ca4
docs(contributing): Git trademark
davorpa Nov 9, 2021
5e74fb3
docs(contributing): YouTube trademark
davorpa Nov 9, 2021
67bfbb5
docs(contributing): ISBN acronym
davorpa Nov 11, 2021
952c9a8
fix: flag emoji code `en` > `us`
davorpa Nov 18, 2021
5ce3add
docs(contributing): Fix fa_IR broken anchors
davorpa Nov 18, 2021
eefdcf5
docs(contributing): filenames in monospace font
davorpa Nov 18, 2021
6e9ea57
docs(contributing): Homogenize `check_urls=file_to_check`
davorpa Nov 18, 2021
01cb7cf
docs(contributing): literals/markup texts in monospace font
davorpa Nov 18, 2021
d6acbbb
docs(contributing): linkify wayback machine
davorpa Nov 18, 2021
d457829
docs(contributing): Fix `Leanpub` trademark typos
davorpa Nov 20, 2021
8335d05
chore: Rename `master` to `main` #blacklivesmatter
davorpa Nov 20, 2021
40ca417
docs(contributing): fix broken ref link to `programming-playgrounds`
davorpa Nov 20, 2021
e66d3a6
docs(contributing): fix repo urls on initial FR translation
davorpa Nov 20, 2021
47e0a09
docs(contributing): fix repo urls of initial FR translation
davorpa Nov 20, 2021
44b8b34
Merge #6627 commit '8335d0508f6658a54214a392f03cf4a9a4867cbb' into da…
davorpa Nov 21, 2021
8edb655
Merge #6619 into davorpa/docs/contributing/sync/1
davorpa Nov 21, 2021
1d504a4
Merge #6614 upstream/main commit into docs/contributing/sync/1
davorpa Nov 28, 2021
86ddcf3
Merge #6627 upstream/main commit into docs/contributing/sync/1
davorpa Nov 28, 2021
65d2408
docs(contributing): use relative urls EN
davorpa Nov 28, 2021
9e31d14
docs(contributing): greek. place translations link in right place
davorpa Nov 28, 2021
0e88060
Merge EbookFoundation/free-programming-books#6631 upstream/main commi…
davorpa Jan 22, 2022
ca6a4d9
Merge EbookFoundation/free-programming-books#6662 upstream/main commi…
davorpa Jan 22, 2022
f4269cd
Merge branch 'main' into davorpa/docs/contributing/sync/1
davorpa Jan 22, 2022
a22edf8
format(contributing): Bold 5th nutshell equal zh
davorpa Jan 30, 2022
693678b
Merge #6677 upstream/main commit into docs/contributing/sync/1
davorpa Feb 2, 2022
ad5059d
Merge upstream/main into docs/contributing/sync/1
davorpa Feb 2, 2022
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Next Next commit
docs(contributing): Apply headings 2-1 empty lines lint rule
forgotten in previous commit: e83220a
  • Loading branch information
davorpa committed Nov 4, 2021
commit c0121b8ca48143130750d9a172a697ab2966bd91
13 changes: 13 additions & 0 deletions CONTRIBUTING-fil.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,14 +2,17 @@


## Kasunduan sa Lisensya ng Contributor

Sa pamamagitan ng pag-aambag sumasang-ayon ka sa [LICENSE](https://github.com/EbookFoundation/free-programming-books/blob/master/LICENSE) ng repositoryong ito.


## Kodigo ng Pag-uugali ng Contributor

Sa pamamagitan ng pag-aambag sumasang-ayon kang igalang ang [Code of Conduct](https://github.com/EbookFoundation/free-programming-books/blob/master/CODE_OF_CONDUCT-fil.md) ng repositoryong ito.


## Sa maikling sabi

1. "Ang isang link para madaling mag-download ng libro" ay hindi palaging isang link sa isang *libre* na libro. Mangyaring mag-ambag lamang ng libreng nilalaman. Tiyaking libre ito. Hindi kami tumatanggap ng mga link sa mga pahina na *nangangailangan* ng gumaganang mga email address upang makakuha ng mga aklat, ngunit malugod naming tinatanggap ang mga listahan na humihiling sa kanila.
2. Hindi mo kailangang malaman ang Git: kung nakakita ka ng isang bagay na interesado na *wala pa sa repo na ito*, mangyaring magbukas ng [Issue](https://github.com/EbookFoundation/free-programming-books/issues) kasama ang iyong mga proposisyon ng link.
- Kung alam mo ang Git, mangyaring Fork ang repo at magpadala ng mga Pull Request (PR).
Expand All @@ -28,6 +31,7 @@ Sa pamamagitan ng pag-aambag sumasang-ayon kang igalang ang [Code of Conduct](ht

<a name="guidelines"></a>
### Mga Alituntunin

- siguraduhin na ang isang libro ay libre. I-double check kung kinakailangan. Nakakatulong ito sa mga admin kung magkomento ka sa PR kung bakit sa tingin mo ay libre ang libro.
- hindi kami tumatanggap ng mga file na naka-host sa Google Drive, Dropbox, Mega, Scribd, Issuu at iba pang katulad na mga platform sa pag-upload ng file
- ipasok ang iyong mga link sa alphabetical order. Kung makakita ka ng maling lugar na link, mangyaring muling ayusin ito at magsumite ng PR
Expand Down Expand Up @@ -56,6 +60,7 @@ Sa pamamagitan ng pag-aambag sumasang-ayon kang igalang ang [Code of Conduct](ht

<a name="formatting"></a>
### Pag-format

- Ang lahat ng mga listahan ay `.md` files. Subukang matuto [Markdown](https://guides.github.com/features/mastering-markdown/) syntax. Simple lang!
- Ang lahat ng mga listahan ay nagsisimula sa isang Index. Ang ideya ay ilista at i-link ang lahat ng seksyon at subsection doon. Panatilihin ito sa alpabetikong pagkakasunud-sunod.
- Gumagamit ang mga seksyon ng antas 3 na mga heading (`###`), at ang mga subsection ay level 4 na mga heading (`####`).
Expand Down Expand Up @@ -134,19 +139,23 @@ GOOD: * [Will Be An Awesome Book Soon](http://example.com/book2.html) - John Doe
GOOD: * [A Way-backed Interesting Book](https://web.archive.org/web/20211016123456/http://example.com/) - John Doe (HTML) *(:card_file_box: archived)*
```


### Mga Tala

Bagama't medyo simple ang mga pangunahing kaalaman, mayroong malaking pagkakaiba-iba sa mga mapagkukunang inilista namin. Narito ang ilang tala sa kung paano natin haharapin ang pagkakaiba-iba na ito.


#### Metadata

Nagbibigay ang aming mga listahan ng kaunting hanay ng metadata: mga pamagat, URL, tagalikha, platform, at tala sa pag-access.


##### Mga pamagat

- Walang naimbentong pamagat. Sinusubukan naming kumuha ng mga pamagat mula sa mga mapagkukunan mismo; ang mga nag-aambag ay pinapayuhan na huwag mag-imbento ng mga pamagat o gamitin ang mga ito sa editoryal kung ito ay maiiwasan. Ang isang pagbubukod ay para sa mas lumang mga gawa; kung pangunahin ang mga ito sa makasaysayang interes, ang isang taon sa panaklong na nakadugtong sa pamagat ay tumutulong sa mga user na malaman kung sila ay interesado.
- Walang pamagat ng ALLCAPS. Kadalasan ay angkop ang title case, ngunit kapag may pagdududa, gamitin ang capitalization mula sa source


##### URLs

- Hindi namin pinahihintulutan ang mga pinaikling URL.
Expand All @@ -155,24 +164,28 @@ Nagbibigay ang aming mga listahan ng kaunting hanay ng metadata: mga pamagat, UR
- Ang mga Secure (https) na URL ay palaging mas gusto kaysa sa mga hindi secure na (http) na mga url kung saan ipinatupad ang https.
- Hindi namin gusto ang mga URL na tumuturo sa mga webpage na hindi nagho-host ng nakalistang mapagkukunan, ngunit sa halip ay tumuturo sa ibang lugar.


##### Mga tagalikha

- Gusto naming pasalamatan ang mga lumikha ng mga libreng mapagkukunan kung saan naaangkop, kabilang ang mga tagasalin!
- Para sa mga isinaling gawa ang orihinal na may-akda ay dapat na kredito.
- Hindi namin pinahihintulutan ang mga link para sa Mga Tagalikha.
- Para sa compilation o remixed na mga gawa, maaaring kailanganin ng "creator" ang isang paglalarawan. Halimbawa, ang mga aklat na "GoalKicker" o "RIP Tutorial" ay kinikilala bilang "`Compiled from StackOverflow Documentation`"


##### Mga Platform at Mga Tala sa Pag-access

- Kurso. Lalo na para sa aming mga listahan ng kurso, ang platform ay isang mahalagang bahagi ng paglalarawan ng mapagkukunan. Ito ay dahil ang mga platform ng kurso ay may iba't ibang mga affordance at mga modelo ng pag-access. Bagama't karaniwang hindi namin ilista ang isang aklat na nangangailangan ng pagpaparehistro, maraming mga platform ng kurso ang may mga affordance na hindi gumagana nang walang isang uri ng account. Kasama sa mga halimbawang platform ng kurso ang Coursera, EdX, Udacity, at Udemy. Kapag ang isang kurso ay nakasalalay sa isang platform, ang pangalan ng platform ay dapat na nakalista sa mga panaklong.
- YouTube. Marami kaming mga kurso na binubuo ng mga playlist sa YouTube. Hindi namin inilista ang Youtube bilang isang platform, sinusubukan naming ilista ang tagalikha ng Youtube, na kadalasan ay isang sub-platform.
- Mga video ng YouTube. Karaniwang hindi kami nagli-link sa mga indibidwal na video sa YouTube maliban kung ang mga ito ay higit sa isang oras ang haba at nakabalangkas tulad ng isang kurso o isang tutorial.
- Leanpub. Nagho-host ang Leanpub ng mga aklat na may iba't ibang modelo ng access. Minsan ang isang libro ay maaaring basahin nang walang pagpaparehistro; minsan ang isang libro ay nangangailangan ng isang Leanpub account para sa libreng pag-access. Dahil sa kalidad ng mga aklat at ang pinaghalong mga modelo ng pag-access sa Leanpub, pinahihintulutan namin ang paglilista ng huli kasama ang tala sa pag-access `*(Leanpub account o valid na email ang hinihiling)*`


#### Mga genre

Ang unang tuntunin sa pagpapasya kung saang listahan kabilang ang isang mapagkukunan ay upang makita kung paano inilalarawan ng mapagkukunan ang sarili nito. Kung ito ay tinatawag na isang libro, marahil ito ay isang libro.


##### Mga genre na hindi namin inililista

Dahil malawak ang Internet, hindi namin isinasama sa aming mga listahan:
Expand Down