Skip to content

Latest commit

 

History

History
84 lines (60 loc) · 6.45 KB

CONTRIBUTING.md

File metadata and controls

84 lines (60 loc) · 6.45 KB

How can I help?

Questions?

Join the chat at https://gitter.im/nupic-community/nostradamIQ Be invited to our Slack-Team!

<script async defer src="https://nostradamiq.herokuapp.com/slackin.js?large"></script>

[Deutsche Version unten zu finden!]

Thank you for your interest! Currently, one of the biggest issues is the gathering of datastreams... If you have other ideas for YOUR contribution, please feel free to contact us!

Here is a quick and easy step-by-step guide about how you can help us make this project reality:

Step 0:

You should be familiar with git and github in general, if you're not, you will be in a few minutes! ![Just watch the short tutorial here: https://www.youtube.com/watch?v=Yc3PKaT1knU] (https://img.youtube.com/vi/Yc3PKaT1knU/0.jpg) For further questions, see Git's Docs!

JavaScript is a really easy-to-learn and generally useful language! If you don't know it, You'll learn it on the fly, no worries! Just see how some of the current codes work and have a nice cheat-sheet like this at hand. And Voil´a! Congrats! You're now set to start!

And Voil´a! Congrats! You're now set to start!

Step 1:

Find a dataset you want to work with here!

You can go with one of the suggested ones, or find your own - please keep in mind to only use reliable and open data. You are also encouraged to request data that is currently not open.

Step 2:

Learn how your dataset works!

In order to stream and parse your data-table or API, you should somewhat understand how the data is structured. This will make the next steps a lot easier!

Step 3:

This is the framework that will make your contribution soo much easier! Just read up a little and see what is already does!

Step 4:

Just follow the insturctions here to build the river for your dataset! Consider looking at the current rivers for inspiration and useful code-snippets!

Step 5:

Pat yourself on the back! Well done! Thank you for your contribution!

If you did not crate your Pull Request, do it now. If you want, you can tell us in there how we can thank you! You will have 140 characters to tell the world (almost) anything! This will be hosted on the nostradamIQ website once we're ready!


Wie kann ich helfen?

Danke für dein Interesse! Derzeit ist eines der größten Probleme des Projektes, das Sammeln von Datenströmen... Wenn Du andere Ideen oder Vorschäge hast wie DU uns am besten helfen kannst, bitte zögere nicht Kontakt aufzunehmen!

Hier ist eine schnelle und einfache Schritt-für-Schritt-Anleitung, wie DU uns helfen kannst nostradamIQ Wirklichkeit werden zu lassen:

Schritt 0:

Du solltest wissen wie du mit Git und Github arbeitest, falls du dich noch nicht auskennst, wirst du es in ein paar Minuten draufhaben!

![Schau dir einfach das Tutorial hier an: https://www.youtube.com/watch?v=Yc3PKaT1knU] (https://img.youtube.com/vi/Yc3PKaT1knU/0.jpg) Bei weiteren Fragen, siehe Git's Docs!

JavaScript ist einfach zu lernen und super hilfreich und beliebt in vielen Bereichen! Wenn Du es noch nicht kennst, mach dir keine Sorgen, Du wirst es schnell während des Codens lernen! Schau dir einfach mal ein paar der jetzigen Codes and und habe ein kleines Cheat-Sheet wie dieses greifbar! Und Voil´a! Glückwunsch! Jetzt kannst Du durchstarten!

Und Voil´a! Glückwunsch! Jetzt kannst Du durchstarten!

Schritt 1:

Finde einen Datensatz mit dem Du arbeiten möchtest hier!

Du kannst mit einem der vorgeschlagenen arbeiten, oder Deinen eigenen finde - bitte habe jedoch im Hinterkopf nur zuverlässige und offene Daten zu verwenden. Du kannst natürlich auch derzeit geschlossene Daten anfragen, setze Dich vorher jedoch bitte mit uns in Kontakt!

Schritt 2:

Lerne wie Deine Datenquelle funktioniert!

Um die Daten gleich streamen und formatieren zu können, ist es sehr hilfreich zu wissen wie Deine Daten-Quelle strukturiert ist. Dies macht die nächsten Schritte viel einfacher!

Schritt 3:

Dies ist der Rahmen, der Deinen Beitrag soo viel leichter machen wird! Ließ dich einfach ein wenig ein und schau wie River-Vie funktioniert!

Schritt 4:

Folge einfach den Anweisungen hier, um den River für Deine Daten-Quelle zu bauen! Ein Blick auf die jetzigen Rivers ist sehr hilfreich für Inspiration und nützliche Code-Schnipsel!

Schritt 5:

Klopf dir auf Deine Schulter! Gut gemacht! Danke für Deine Hilfe!

Wenn Du noch keine Pull-Request gestellt hast, tue es bitte jetzt. Wenn Du möchtest, kannst Du uns dort sagen wie wir Dir danken können! Du hast 140 Characters, um der Welt (fast) alles zu erzählen! Dies wird auf der nostradamIQ Website gehostet werden, sobald wir soweit sind!