We're so glad you're thinking about contributing to a Planning Labs open source project! If you're unsure about anything, just ask — or submit the issue or pull request anyway. The worst that can happen is you'll be politely asked to change something. We love all friendly contributions.
We encourage you to read this project's CONTRIBUTING policy (you are here), its LICENSE, and its README.
If you have any questions or want to read more, check out the NYC Planning Labs Open Source Policy GitHub repository, or just shoot us an email.
This repository has two evergreen branches: master and develop
(avoid directly committing changes to these two branches).
| Branch | Notes |
|---|---|
master |
Master is always deployable and only accepts merges from develop. |
develop |
Accepts merges from feature and issue branches. |
| Feature/Issues | Always branch off HEAD of develop. Prefix feature branches with your name (e.g. user-feature_name). Prefix issue branches with the issue number (e.g. 123-issue_name). |
| Hotfixes | In rare cases, hotfix branches must be created to quickly update the project. Always branch off master and make sure those changes make it back into develop. |
We want to ensure a welcoming environment for all of our projects. Planning Labs follows the 18F Code of Conduct and all contributors should do the same.
This project is in the public domain within the United States, and copyright and related rights in the work worldwide are waived through the CC0 1.0 Universal public domain dedication.
All contributions to this project will be released under the CC0 dedication. By submitting a pull request, you are agreeing to comply with this waiver of copyright interest.