This repository is intended to be a way for first-time open source contributors to get their feet wet. We want to keep it as easy as possible to contribute changes that get new contributors used to the process. There are a few guidelines that we need contributors to follow.
- Make sure you have a GitHub account.
- Fork the repository on GitHub.
- Create a feature branch for your contribution.
- To quickly create a feature branch based on master, run
git checkout -b add-[name]-[city-name]where[city-name]is the name of your city and[name]is your name. Please avoid working directly on themasterbranch. - Make commits of logical units, only one change per commit. Make sure entry has a blank line between it and the previous entry.
- Make sure your commit messages are in the proper format. Usually, this will just be
Adding [name] from [city-name]where[city-name]is the name of your city and[name]is your name.
- Push your changes to a topic branch in your fork of the repository.
- Submit a pull request to the kkoppenhaver version of the respository.
- Any feedback will be provided directly on the pull request.
Any additional questions can be directed to me via email or via Twitter