If you just want to play around with Hoodie, you can take our Hoodie Camp Tutorial and check out our Tracker App and it’s uber-simple source code.
If you want to contribute art, code, design, documentation or editorial work, the basic requirements are
- A GitHub account
GitHub is not only where Hoodie’s code is hosted, but also our website, blog, documentation and much more. We also use GitHub issues for general discussions. - A browser to use GitHub :)
Many contributions don’t require you to install things like git on your machine, you can start pull requests with only your browser right on github.com
For Code contributions, you will also need a terminal, git, node & npm.
- Terminal:
- For Windows users: we recommend the app cmder
- For Mac users: you can use the built-in terminal. Press command + space and type in “Terminal”, confirm with enter. Now you can type in commands like
node -v - For Linux users: you got this :)
- Git: https://git-scm.com/
- Node (Version 4 or higher): https://nodejs.org/en/
- npm (Version 3 or higher): comes with node. Check version with
npm -vin Terminal. Update withnpm install —global npm
A usual workflow for contributing editing work is like this: comment on an open issue to claim it or create a new one. Use your tool of choice to do the writing, comment with a link where others can access and ideally comment on it (Google Docs works great for us). Once the editing is done, you can send a pull request to the right place, which can be done entirely in the browser. See an example screencast here: https://dl.dropboxusercontent.com/u/732913/hoodie/howto-create-blog-post-draft.mov. We can also give hands-on support to walk you through the process.
Find prepared editorial issues here: https://github.com/hoodiehq/camp/issues?utf8=%E2%9C%93&q=is%3Aissue+is%3Aopen+label%3A%22up+for+grabs%22+label%3Aeditorial
You will most likely need git & node in order to setup our apps locally. But some of them are hosted online and some of the issues are about coming up with a good user experience for something that does not exist yet.
Find prepared design issues here: https://github.com/hoodiehq/camp/issues?utf8=%E2%9C%93&q=is%3Aissue+is%3Aopen+label%3A%22up+for+grabs%22+label%3Adesign
Hoodie wouldn’t be what it is without it’s animals. They represent the different teams in the Hoodie community, not only in their backgrounds and kind of contributions but also in their diversity. And they are cute, and fun. Why is that important? We are an open source project, run by volunteers. We are doomed to be fun :) Or people will find a better way to spend their time.
Besides illustrations and [a music jingle for our Screencasts], we love and appreciate art. We think Open Source and art communities have a lot in common, and would love to explore how we can join forces :)
We don’t have any issues prepared at this point, but please talk to us if you are interested.
We <3 you. We need you. Please help us making Hoodie’s documentation awesome.
Documentation is what keeps us from releasing our new Hoodie version, the “Camp Release”. While the code is ready (you can use the new hoodie today), the documentation on docs.hood.ie is still for the old hoodie.
The new APIs are mostly documented, but it’s spread around different README’s. See the Hoodie Architecture, click on the Octocat Icons. For example the hoodie.account.* API is the same as documented in the hoodie-account-client README.
Find prepared documentation issues here: https://github.com/hoodiehq/camp/issues?utf8=%E2%9C%93&q=is%3Aissue+is%3Aopen+label%3A%22up+for+grabs%22+label%3Adocumentation
https://camp-tutorial.hood.ie/
If you want to build an own app, you can use this one as a starting point
https://github.com/hoodiehq/hoodie-app-tracker
We prepared a few issues only for you: https://github.com/hoodiehq/camp/issues
Besides the ones listed, we have an ongoing issue to fix inconsistencies between our Account JSON Api and its implementaion.
Another great things to do is to create example applications / adapters for your favourite frontend framework / library like Angular, Ember, React, you name it.