-
Notifications
You must be signed in to change notification settings - Fork 16
Open Sourcing Procedure
Tasks to be completed before migration to public organisation.
To be carried out/reviewed by the Repository Owner:
- Ensure repository has valid licence file.
BHoM defaults to LGPL v3 https://github.com/BHoM/BHoM/blob/master/LICENSE.
Repositories can naturally be licenced differently, but by exception only and through coordination with BHoM Organisation Administrators. In addition this will also require modifications to the repo's copyright headers in every code file. - All code files must have a valid BHoM copyright header compatible with licencing (see point above) See here for the default https://github.com/BHoM/BHoM/blob/master/COPYRIGHT_HEADER.txt
- Assembly information and the included copyright must also conform to BHoM standards.
Such as[assembly: AssemblyCopyright("Copyright © https://github.com/BHoM")]
-
Introduction to the BHoM:
What is the BHoM for?
Structure of the BHoM
Technical Philosophy of the BHoM -
Getting Started:
Installing the BHoM
Using the BHoM
Submitting an Issue
Getting started for developers -
Use GitHub & Visual Studio:
Using the SCRUM Board
Resolving an Issue
Avoiding Conflicts
Creating a new Repository
Using Visual Studio
Using Visual Studio Code -
Contribute:
The oM
The Engine
The Adapter
The Toolkit
The UI
The Tests -
Guidelines:
Unit convention
Geometry
BHoM_Engine Classes
The IImmutable Interface
Handling Exceptional Events
BHoM Structural Conventions
BHoM View Quality Conventions
Code Versioning
Wiki Style
Coding Style
Null Handling
Code Attributes
Creating Icons
Changelog
Releases and Versioning
Open Sourcing Procedure
Dataset guidelines -
Foundational Interfaces:
IElement Required Extension Methods -
Continuous Integration:
Introduction
Check-PR-Builds
Check-Core
Check-Installer -
Code Compliance:
Compliance -
Further Reading:
FAQ
Structural Adapters
Mongo_Toolkit
Socket_Toolkit