Skip to content

Latest commit

 

History

History
25 lines (17 loc) · 2.92 KB

CONTRIBUTING.md

File metadata and controls

25 lines (17 loc) · 2.92 KB

Contributing to OpenStudio

We'd love for you to contribute to OpenStudio to make it better than it is today! Here are the guidelines we'd like you to follow:

Got a Question or Problem?

Please direct questions about how to use OpenStudio to unmethours. This is a community moderated resource and will provide the fastest answers to your questions.

Found a Bug?

If you find a bug, you can help us by submitting an issue to our issues page. Before submitting your issue please search existing issues to see if your bug has already been reported. If reporting a new issue, please be as detailed as you can be in your report to help developers reproduce your issue so they can fix the problem. For example, report the platform that you are on, the version of OpenStudio you are using, etc. Before reporting an issue please read our wiki entry for instructions on properly labelling issues.

Want a Better Feature?

You can request a feature enhancement by submitting an issue to our issues page. Before submitting your issue please search existing issues to see if your request has already been reported. If requesting a new enhancement, please be as detailed as you can be in your report to help developers understand what you are looking for. Before reporting a feature enhancement please read our wiki entry for instructions on properly labelling issues. Note that an enhancement is NOT a bug!

Want to Follow Along?

You can follow the progress and activity on issues important to you in several ways. Subscribe to notifications on an issue to get emailed whenever there is activity on that specific issue. Commenting on an issue will allow you to give your inputs and will also subscribe you. Finally, if you want to support bug fix or feature requests that are important to you, use the +1 reaction on the first comment in the issue thread. This will help us prioritize which issues are most important to users.

Want to Submit Code?

If you want to directly submit code to implement a feature or fix a bug then you are our hero. Small patches or bug fixes are invited via pull requests. Please read the information for third party collaborators wiki entry for information about this process. However, larger features or substantial development requires following the OpenStudio contribution policy.