Osallistuminen
Kaikki tapahtuu GitHubissa. Muuta foorumia, chattia tai rekisteröitävää tiliä ei ole.
| Kun haluat | Käytä |
|---|---|
| Ehdottaa sovellusta tai palvelua | Avaa ”Suggest”-issue |
| Ilmoittaa väärästä vastauksesta tai rikkinäisestä linkistä | Avaa ”Correction”-issue tai käytä minkä tahansa arviosivun kohtaa ”Ilmoita korjaus” |
| Ehdottaa kriteerejä tai muuttaa niitä | Avaa ”Criteria change” -issue |
| Korjata asian itse | Käytä minkä tahansa arviosivun kohtaa ”Muokkaa GitHubissa” tai avaa pull request |
| Kysyä kysymyksen tai keskustella suosituksesta | GitHub Discussions |
Arvion muokkaaminen
Jokainen sovellus tai palvelu on yksi Markdown-tiedosto polussa ratings/<category>/<name>.md. Tiedoston alussa on YAMLia. Sen alapuolella oleva sisältö on valinnaisia Markdown-huomautuksia, jotka näytetään sivulla.
---
name: Example Mail
description: >-
One or two plain sentences about what it is.
website: https://example.com
source: https://github.com/example/example # optional
platforms: [web, android, ios] # optional
jurisdiction: CH # optional, country code from jurisdictions.yml
mainstream: true # optional, adds an "alternatives to" page
aliases: [Example Office, Example Docs] # optional, other names people search for
also_in: [macos-hardening] # optional, also list it in another category's table
alternatives_page: true # optional, adds an "alternatives to" page without mainstream
domain: mail.example.com # services only, used for automated tests
mail_domain: example.com # email categories only
imap_host: imap.example.com # email providers only; false if not offered
pop3_host: pop3.example.com # optional, found from SRV records when missing
smtp_host: smtp.example.com # optional, found from SRV records when missing
criteria:
open_source:
answer: partial
evidence: https://github.com/example/example/blob/main/LICENSE
note: Apps are open source. The server is not.
no_ads:
answer: yes
evidence: https://example.com/pricing
---
Optional notes in Markdown.
Säännöt (npm test tarkistaa ne automaattisesti):
answeron jokin arvoistayes,partial,no,unknowntain/a.yesjapartialvaativatevidence-linkin.novaatiinote- taievidence-kentän.- Todisteen on oltava ensisijainen lähde: virallinen dokumentaatio, lähdekoodi, lisenssitiedosto, auditointiraportti tai toistettava testi. Ei arvosteluja, foorumiviestejä tai yksityiskohdattomia markkinointisivuja.
- Linkkien on oltava
https://-muotoisia, eikä niissä saa olla suosittelu- tai seurantaparametreja. - Automaattiset kriteerit (
tls,security_headers,web_standards,mail_standards,imap_standards,pop3_standards,smtp_standards,transport_security) täytetään testeillä. Älä aseta niitä käsin. no_trackerstarkistetaan myös seurantatestillä. Jos etusivu lataa kolmannen osapuolen seurantatyökalun, vastaukseksi tulee ”no” riippumatta siitä, mitä tiedostossa lukee.- Jätä pois kriteerit, joille ei vielä ole todisteita. Ne lasketaan arvoksi
unknown. jurisdictionon maa, jossa yrityksen oikeudellinen kotipaikka on (ei se, missä sen palvelimet ovat). Lisää maa tiedostoonjurisdictions.yml, jos se puuttuu. Jokainen siellä oleva huomautus vaatii lähteen.- Vain ylläpitäjät lisäävät kentät
pick,pick_reasonjadisclosure. Järjestä kaksi suositusta merkinnöilläpick: 1japick: 2. Katso GOVERNANCE.md. imported_namesäilyttää nimen, joka kohteella oli Awesome Privacyssa ennen uudelleennimeämistä, jotta kuukausittainen tuonti ei lisää sitä uudelleen. Jos haluat jättää Awesome Privacyn kohteen pysyvästi pois, lisää se perusteluineen tiedostoonimport-skip.yml.
Kunkin kategorian kriteerit ja kunkin vastauksen merkitys ovat kansiossa criteria/ ja kriteerisivulla.
Sovelluksen tai palvelun lisääminen
npm ci
npm run new -- vpns "Example VPN" https://example.com
Tämä luo tiedoston, jossa jokainen kriteeri on merkitty arvolla unknown. Täytä se, minkä voit todistaa, poista loput ja suorita sitten npm test.
Kirjoitustyyli
- Selkeää, neutraalia kieltä. Kuvaa, mitä jokin tekee, älä sitä, kuinka hieno se on.
- Lyhyitä virkkeitä. Kuvaukset ovat alle 300 merkkiä.
- Ei ensimmäistä persoonaa, ei päivämääriä leipätekstissä, ei markkinointiväitteitä.
- Nimeä asiat samoin kuin valmistaja.
Sivuston ajaminen paikallisesti
Vaatii Node.js:n version 18 tai uudemman.
npm ci
npm test # validate data and build the site
npm run serve # preview at http://localhost:8080
Sivun lisääminen
Lisää kansioon pages/ Markdown-tiedosto, jossa on title ja description. Se julkaistaan osoitteessa /<file-name>/ Markdown-kopion, rakenteisten tietojen ja sivukarttamerkinnän kanssa.
Kategorian tai kriteerin lisääminen
- Lisää kategoria tiedostoon
categories.ymloikean ryhmän alle. - Lisää halutessasi
criteria/<category-id>.yml, jossa on kategoriakohtaiset kriteerit. Kopioi muoto olemassa olevasta tiedostosta. - Luo
ratings/<category-id>/ja lisää kohteet. - Kriteerimuutoksissa noudatetaan tiedoston GOVERNANCE.md tarkistussääntöjä.
Käännökset
Sivusto julkaistaan 25 kielellä. Lähdekieli on englanti, ja jokainen muu kieli on kansiossa i18n/<code>/:
| Tiedosto | Sisältö |
|---|---|
ui.json |
Käyttöliittymän tekstit: otsikot, painikkeet ja lauseet, joissa on {placeholders} |
data.json |
Kategorioiden nimet, kriteerit, oppaat ja maakohtaiset huomautukset |
entries.json |
Arvioiden kuvaukset, suositusten perustelut ja sidonnaisuusilmoitukset |
pages/*.md |
Kokonaiset asiakirjat, kuten tämä |
Jokainen JSON-tiedosto liittää englanninkieliseen tekstiin sen käännöksen. Kun englanninkielinen teksti muuttuu, vanha käännös ei enää vastaa sitä, joten englanninkielinen teksti näytetään, kunnes joku kääntää uuden tekstin. Vanhentunutta sisältöä ei näytetä koskaan.
- Suorita
npm run build. Se kirjoittaa ajantasaiset englanninkieliset luettelot kansiooni18n/source/. - Suorita
npm run i18n:checknähdäksesi, mitä kustakin kielestä puuttuu, tainode scripts/i18n-check.js de uiyhden kielen ja tiedoston tarkempia tietoja varten. - Lisää tai korjaa käännöksiä ja säilytä jokainen
{placeholder}täsmälleen ennallaan. - Asiakirjaa varten kopioi englanninkielinen teksti kansiosta
i18n/source/pages/, säilytä sen ensimmäinen rivi (<!-- source: … -->, joka sitoo käännöksen kyseiseen englanninkieliseen versioon) ja käännä loput.
Yksittäisten vastausten huomautukset ja todisteet pysyvät englanniksi. Vertailut ja useimmat yksittäiset arviot ovat vain englanniksi; suositukset, kategoriat, oppaat, vaihtoehdot, avoimen lähdekoodin luettelot, lainkäyttöalueet ja asiakirjat käännetään. Kielivalikko ja automaattinen uudelleenohjaus käyttävät kunkin sivun hreflang-linkkejä.
Pull requestin tarkistuslista
-
npm testmenee läpi. - Jokainen muutettu vastaus linkittää todisteisiin.
- Jos työskentelet muuttamassasi palvelussa tai olet siihen muuten sidoksissa, kerroit siitä pull requestissa.