This repo is for our organizations website at codeforfoco.org.
Before you can run the website on your machine you need to ensure you have some prerequisites installed:
- Fork this repository and clone your fork.
cd
into the cloned directory.- Run
git submodule update --init --recursive
to install several third-party submodules. - Install Ruby V2 or greater, we recommend you use RVM
- Install
bundler
by runninggem install bundler
- Install any Ruby dependencies by running
bundle install
Once all the dependencies have been installed you run the development server with:
bundle exec jekyll serve
Open your browser up to localhost:8080 to view the development site.
We welcome new contributors. Be sure to check out guide on contributing, which includes instructions on how to fork, clone, branch, commit, pull request and sync your fork.
Not sure where to start? Look for open issues on GitHub, or message the team on [our Slack site][slack]. If you aren't on our Slack, [click here for an invite][slackinvite].
TL;DR Contribution Workflow:
- Fork this repository and Clone your fork locally.
- Checkout a new branch on which to make your changes.
- Make edits. Try to match existing coding style.
- Test your changes.
- Commit your changes. Push your changes to your fork on GitHub.
- Submit a new pull request and your changes will be reviewed and merged.
We encourage you to open up an issue if you have any feedback, suggestions or bugs.
MIT, see LICENSE for full license.