Diese npm Library erlaubt es Browser- oder Gerätespezifische Informationen zu erkennen, z.B. die Zeitzone, Bildschirmauflösung/-größe, Browser Konfigurationen usw. Hersteller von Software müssen solche Informationen zu Zwecken der Betrugsprävention oftmals an steuerliche Behörden senden.
z.B. fordern die britische Steuerbehörde HM Revenue and Customs(HMRC) Softwareentwickler dazu, dass manche APIs sogenannte Fraud Prevention Headers, sprich Betrugspräventions Header, zur Verfügungen stellen. Dieses Node Module sammelt solche Informationen für dich im benötigten Format.
Jeder top level Ordner in src/js
besitzt eine eigene README Datei mit spezifischen Informationen zum Usecase, z.B. HMRC README
Eine Anleitung kann hier gefunden werden hier
Eine Anleitung zum Testen von Änderungen kann hier gefunden werden hier
Wenn du zum Projekt beitragen möchtest, musst du kein Issue claimen. Falls du etwas Interessantes findest, kannst du einfach zum Repo beitragen. Öffne einfach einen PR. Du musst uns nicht vorab Bescheid geben
- Fork das Repository
- Installiere Dependencies lokal indem du folgenden Command ausführst: `yarn``
- Änder Teile des Codes
- Stelle sicher, dass der Build noch funktioniert
yarn build
- Lass die Tests laufen (Du hast doch wohl Tests hinzugefügt oder?)
yarn test
- Teste die Änderungen in deinem Code oder benütze unser Demo Projekt: Run
yarn link
- Stell sicher, dass die Code Coverage nach deinen Änderungen gleich geblieben ist oder höher ist.
- Formattiere deine Commit Message richtig:
type(subject): input
. z.B.:chore(prettier): update prettier to 2.x
- Erstelle einen PR mit dem
master
Branch als Zielbranch - Codeowners werden automatischen benachrichtigt, du musst also keinen Reviewer festlegen
Die folgende Struktur sollte beibehalten werden.
der implementation Order sollte umbenannt werden, so dass er zu dem Problem passt, das du mit deiner Änderung löst.
z.B. heißt der Ordner für die HMRC hmrc
Project
└──src
└──js
└──common // Common und nicht-spezifischer Code sollte hier sein
└──implementation // Code der für die Implementierung spezifisch ist sollte hier sein
Du kannst dich auf 2 Wegen als Contributor hinzufügen:
- Ruf den @all-contributors bot indem du den folgenden Kommentar in deinen PR einfügst: @all-contributors please add [username] for [contributions]. Für weitere Informationen kannst du in die Docs reinschauen: docs
- Benutze die all-contributors-cli indem du folgenden Command aufrufst
npx all-contributors add [username] [contributions]
. Für weitere Informationen kannst du in die Docs reinschauen: docs
Alle Parameter sind notwendig Für eine Liste von validen Contribution Types kannst du hier reinschauen: Emoji Key (Contribution Types Reference)
Please see our CHANGELOG
README in anderen Sprachen: