In the spirit of open source, everyone is encouraged to help improve this project! That said, please keep these guidelines in mind in order to make your contributions as useful as possible.
If you notice any bugs while using Streetmix, please let us know by opening a new issue. When you do, please include the following information:
- What web browser you're using (i.e. MS Internet Explorer, Google Chrome, Firefox), what version (i.e. 9.0, 27), and what operating system you're using (i.e. Mac OS X 10.8, Windows 7, Android 4.1).
- What you expected to happen when you encountered the bug.
- What actually happened.
- Steps we can follow to reproduce the bug.
- Any other information you think might be at all helpful.
If you have any ideas for new features or functionality for Streetmix, we'd love to hear about them! Unfortunately, we can't promise to build everything, but we are receptive to all thoughts you have on how Streetmix could be more useful. Shoot us an email or open an issue.
Note: before suggesting a new feature or reporting a bug, we'd really appreciate it if you could please search our issues to make sure it hasn't already been reported. If there is already an issue, feel free to add a comment – and if there's isn't an issue, please open a new one.
If you have the capacity to write code, and wish to contribute to Streetmix, we'd love your help!
A request: before you write any new feature or code, please open an issue, or comment on the issue you'd like to work on. That way the maintainers of the project can guide your work from the outset, making it more likely that we'll be able to accept your work when it's ready.
In general, you can help by:
- Writing or editing documentation
- Writing code (no patch is too small: fix typos, add comments, clean up inconsistent whitespace)
- Refactoring code
- Closing issues
- Reviewing patches
Once your code is ready, please push your work to a feature branch on your fork of the Streetmix repo, and submit a pull request to us.
Unfortunately, we are not accepting illustration contributions at this time. If you have feedback on our illustrations, or if you think we should consider adding new elements, please follow the instructions for feature requests/feedback above.