docs(Initial-docs): add initial documentation
This commit is contained in:
parent
92d69ee13b
commit
1a95a1269e
7 changed files with 49 additions and 3 deletions
1
.gitignore
vendored
Normal file
1
.gitignore
vendored
Normal file
|
@ -0,0 +1 @@
|
|||
venv
|
8
.pre-commit-config.yaml
Normal file
8
.pre-commit-config.yaml
Normal file
|
@ -0,0 +1,8 @@
|
|||
repos:
|
||||
- hooks:
|
||||
- id: commitizen
|
||||
- id: commitizen-branch
|
||||
stages:
|
||||
- push
|
||||
repo: https://github.com/commitizen-tools/commitizen
|
||||
rev: v3.29.1
|
1
CHANGELOG.md
Normal file
1
CHANGELOG.md
Normal file
|
@ -0,0 +1 @@
|
|||
## Unreleased
|
22
README.md
22
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.
|
||||
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/
|
||||
|
|
10
cz.json
Normal file
10
cz.json
Normal file
|
@ -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
|
||||
}
|
||||
}
|
7
init_commitizen
Executable file
7
init_commitizen
Executable file
|
@ -0,0 +1,7 @@
|
|||
#! /bin/bash
|
||||
|
||||
python -m venv venv
|
||||
source venv/bin/activate
|
||||
|
||||
# Install Commitizen
|
||||
pip install -r requirements.txt
|
3
requirements.txt
Normal file
3
requirements.txt
Normal file
|
@ -0,0 +1,3 @@
|
|||
commitizen
|
||||
pipx
|
||||
pre-commit
|
Loading…
Reference in a new issue