Thank you for your interest in contributing! By participating in this project, you agree to abide by a specific code of conduct.
If you would like to contribute to this project, to start, you can report issues or suggest enhancements in the issue queue. We typically will have discussion there, then create a pull request (PR) once we agree on what needs doing.
By contributing to this project, you agree to the terms set out in the project's LICENSE file, as well as the contributor license agreement for the project (you'll be prompted to sign that when you submit a pull request).
Fork, then clone the repo:
git clone git@github.com:your-username/school-finder.git
Run a local webserver
# This lets you use just type "ws" to get a server running on Mac.
# If you are on Windows, perhaps just install python and run `python -m SimpleHTTPServer`
alias ws='python -m SimpleHTTPServer'
ws
Make your change. Use any editor of your choice. Atom and Brackets are both nice.
Test your changes. Currently, that's just done in your browser manually.
Push to your fork and submit a pull request.
At this point you're waiting on us. We like to at least comment on pull requests within one week. We may suggest some changes or improvements or alternatives.
- Write tests. At a minimum, describe in your PR what the previous behavior was, and how to verify the new behavior.
- Follow our style guide.
- Write a good commit message.
- In the PR (or in a commit if just one commit resolves an issue),
please include
Fixes #<issue-number>"(i.e. "Fixes #123") so that issue is automatically closed when the commit is merged into master. See https://help.github.com/articles/closing-issues-via-commit-messages/ for more on how that works. - Tackle only one issue per pull request. See these git tricks on
managing multiple branches with
git.