-
Notifications
You must be signed in to change notification settings - Fork 16
Creating a New Repo
All of the repositories within the BHoM organisation contain only curated and strongly controlled code. The aim is to provide a coherent set of tools that are all compatible with each other. As well as clear and robust quality control, review and testing procedures - enabling release across a wider part of the practice.
For more details on the organisation of the BHoM repos See Overview of the Structure of the BHoM and the other links from within What is the BHoM?
Following the clarification of the best location for different code above - instructions on how to create a new BHoM Repo with the correct settings:
-
Name the Repo SoftwareNameOrFocus _Toolkit. It will always end in Toolkit see explaination here
-
Make sure the Public option is selected.
-
Under Settings -> Options. Ensure only Rebase merging is enabled
-
Add a Team under Collaborators and teams
-
Under Branches. Set the master Branch as protected with the following settings (click edit on the right-hand side of the listed master branch)
- If you don't have a team for that repo yet, you can create it here. Make sure the team has the same name as the repo and that you have added the repo into its list of repositories with the the "Write" access level. Now you should be able to link it in the branch setup page above.
TODO: provide details about:
- Readme file
- License file
- gitignore file
- VS template
-
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