Permalink
Switch branches/tags
Nothing to show
Find file Copy path
Fetching contributors…
Cannot retrieve contributors at this time
38 lines (26 sloc) 1.62 KB

How to contribute

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.

Getting Started

Making Changes

  • 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 the master branch.
  • 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.

Submitting Changes

  • 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.

Questions

Any additional questions can be directed to me via email or via Twitter

Additional Resources