If you want to contribute content, first open an issue describing your addition to get early feedback on the content that you are adding. This will also help avoid wasted / duplicate efforts and ensure that your work is incorporated into the website.
Did you see something wrong on StartHacking.org? Sorry about that! Bug reports are greatly appreciated.
When you submit a bug report, please include relevant information such as the page you were on and what exactly was wrong.
StartHacking.org uses Jekyll, a static site generator.
To start, clone this repository recursively and change directories.
git clone --recursive [email protected]:starthacking/starthacking.github.io.git cd starthacking.github.io
neat are git submodules, so you will need to initialize them:
git submodule init git submodule update
bundle install to fetch and install dependencies.
bundle exec jekyll build to build the site (into the
For development purposes, it’s helpful to run
bundle exec jekyll
serve --watch. This will watch the source for changes, rebuild when necessary,
and serve the site at
When working on a new feature, branch off
requests are merged in using non-fast-forward merges using
git merge --no-ff.
master branch is the live version of the site that is available at
When submitting a pull request, your version history should be clean, and your commit messages should be descriptive and properly formatted.
This project uses EditorConfig to make it easier to maintain a consistent code style. We highly recommend that you use the plugin.
There are other conventions (such as 80-column lines) that are not captured in the EditorConfig. In addition, please try your best to maintain consistency with the rest of the project in terms of formatting, writing style, and coding style.