diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..f5e96db --- /dev/null +++ b/.gitignore @@ -0,0 +1 @@ +venv \ No newline at end of file diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml new file mode 100644 index 0000000..cd23e24 --- /dev/null +++ b/.pre-commit-config.yaml @@ -0,0 +1,8 @@ +repos: +- hooks: + - id: commitizen + - id: commitizen-branch + stages: + - push + repo: https://github.com/commitizen-tools/commitizen + rev: v3.29.1 diff --git a/CHANGELOG.md b/CHANGELOG.md new file mode 100644 index 0000000..268a01b --- /dev/null +++ b/CHANGELOG.md @@ -0,0 +1 @@ +## Unreleased diff --git a/README.md b/README.md index 9ecc9c6..8bdb18f 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,20 @@ -Welcome to Nu! -============ +# Welcome to Nu! -This is a OpenSource BDSM scripting project. We hope you enjoy your stay. \ No newline at end of file +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 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/ diff --git a/cz.json b/cz.json new file mode 100644 index 0000000..1c3841b --- /dev/null +++ b/cz.json @@ -0,0 +1,10 @@ +{ + "commitizen": { + "name": "cz_conventional_commits", + "tag_format": "$version", + "version_scheme": "semver", + "version": "0.0.1", + "update_changelog_on_bump": true, + "major_version_zero": true + } +} \ No newline at end of file diff --git a/init_commitizen b/init_commitizen new file mode 100755 index 0000000..4e89a3e --- /dev/null +++ b/init_commitizen @@ -0,0 +1,7 @@ +#! /bin/bash + +python -m venv venv +source venv/bin/activate + +# Install Commitizen +pip install -r requirements.txt \ No newline at end of file diff --git a/requirements.txt b/requirements.txt new file mode 100644 index 0000000..3c76eb0 --- /dev/null +++ b/requirements.txt @@ -0,0 +1,3 @@ +commitizen +pipx +pre-commit \ No newline at end of file