NuSystem/README.md
zontreck ec2f61125f docs(readme): add changelog section to readme
Signed-off-by: zontreck <tarapiccari@gmail.com>
2024-10-05 00:39:25 -07:00

24 lines
883 B
Markdown

# Welcome to Nu!
This is a OpenSource BDSM scripting project. We hope you enjoy your stay.
# Required Header
```lsl
This file is a part of NuSystem (https://git.zontreck.com/AriasCreations/NuSystem)
NuSystem is licensed under the GPL.
Please see the Git Source Tree for structured information on changes to indivudual files
Initial Author: <insert name> (insert email)
```
# Contributing
We utilize Git Commitizen for structuring commits in a way that is compatible with automatically generating changelogs. If you submit a PR without utilizing git cz, you will be asked to resubmit the PR with CZ based commits.
https://commitizen-tools.github.io/commitizen/
# Changelog
The changelog is automatically generated by `cz`. To generate a changelog any time, use this command: `cz ch`, however the changelog is automatically generated and committed whenever `cz bump` is run.