Skip to content

Latest commit

 

History

History
63 lines (33 loc) · 3.46 KB

CONTRIBUTING.md

File metadata and controls

63 lines (33 loc) · 3.46 KB

Contributing to the BHoM

Great to see you here! 😄 There are a number of ways to contribute and get involved in the Buildings and Habitats object Model (the BHoM). Please do take a read and reach out if curious to join in with our collective experiment. hello@bhom.xyz
Check out our wiki too for more info about the BHoM and how it works.

Do also take a look at our code of conduct (we also have one for bots too if that is you? 👍 🤖)

Get stuck in

  • Submit an issue

    Found a bug? 🐛 Have an idea for a feature? 🧠 Why not submit an issue?

  • Contribute code

    Want to hack? 💻 Know how to fix an open issue? Branch 🌴 or Fork 🍴 away and feel free to raise a Pull Request to start a conversation. See resolving an issue!

Other ways to contribute

  • Just get involved in the community

    Even if you do not have code to contribute you can still get involved. Join the discussion on existing issues and pull requests, or open a new question issue to ask about any aspect of the BHoM code or toolkits.
    Also do feel free to ask questions or join the conversation on BHoM discussions 📣

  • Contribute documentation

    Know some details that are not documented? Think that the documentation that is there is lacking detail? Got an example or tutorial you would like to share? 🎓 See editing the documentation and submit pull requests related to documentation too. If you've published some samples or tutorials somewhere else online, let us know!

  • Suggest a new Toolkit

    Use an application that does not already have a BHoM Adapter? Reach out on https://github.com/orgs/BHoM/discussions and let us and others know what you'd like to see. 🙋

  • Building a new BHoM Toolkit yourself?

    We'd love to hear from you as we may wish to help you maintain it. 🚧

Get even more involved

As a free software project anybody can contribute to the BHoM or create their own derivatives. The roadmaps and development objectives for the core BHoM is primarily maintained by a group of Core Maintainers who form the BHoM Governance Organisation. This group is open to anyone willing and able, with contributions warmly encouraged as detailed in our governance document.

If you might be interested in becoming listed as a Core Maintainer please contact us at hello@bhom.xyz

We will be excited to hear from you!

Contact us

Further links