Contributing to Neulabs Handbook Constructs

Code of Conduct

Please read the full text so that you can understand what actions will and will not be tolerated.

We have two type of issue:

Reuirements:

Setup env:

yarn && yarn start

Do you want to create/update/delete pages?

You will have to open the pr ask 2 or more people for revision. The addition or update must conform to the structure of the handbook.

For the suggestion of a new section, you can create an issue and possibly implement your solution which will then have to go through approval

How should I write my commits when merging?

You have to select Squash and merge and choose a commit message compliant with Conventional Commit messages.

The most important prefixes you should have in mind are:

fix: which represents bug fixes, and correlates to a SemVer patch.
feat: which represents a new feature, and correlates to a SemVer minor.
feat!:, or fix!:, refactor!:, etc., which represent a breaking change (indicated by the !) and will result in a SemVer major.

Our super set:

Example: