From c5204da966b20589f273c9e29a57cdfc861cf50b Mon Sep 17 00:00:00 2001 From: Jiwoo Lee Date: Tue, 3 Oct 2023 17:20:17 -0700 Subject: [PATCH 1/2] clean up --- docs/contributing.rst | 6 +++--- docs/index.rst | 1 + 2 files changed, 4 insertions(+), 3 deletions(-) diff --git a/docs/contributing.rst b/docs/contributing.rst index 44c4c7fd7..886921cd4 100644 --- a/docs/contributing.rst +++ b/docs/contributing.rst @@ -1,8 +1,8 @@ .. highlight:: shell -============ -Contributing -============ +================== +Contributing Guide +================== Contributions are welcome and greatly appreciated! Every little bit helps, and credit will always be given. diff --git a/docs/index.rst b/docs/index.rst index 62ebe58cd..ed1adb90e 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -78,6 +78,7 @@ BSD 3-Clause License. See `LICENSE From b05da9d11c7ddeed80620f7c140a4987e056ade5 Mon Sep 17 00:00:00 2001 From: Jiwoo Lee Date: Tue, 3 Oct 2023 17:24:29 -0700 Subject: [PATCH 2/2] add image files --- docs/_static/git-flow.svg | 1 + docs/_static/pre-commit-flow.svg | 1 + 2 files changed, 2 insertions(+) create mode 100644 docs/_static/git-flow.svg create mode 100644 docs/_static/pre-commit-flow.svg diff --git a/docs/_static/git-flow.svg b/docs/_static/git-flow.svg new file mode 100644 index 000000000..593e5149f --- /dev/null +++ b/docs/_static/git-flow.svg @@ -0,0 +1 @@ +
Master
Master
Feature
Feature
Hotfix
Hotfix
v1.0
v1.0
v1.1
v1.1
v1.2
v1.2Viewer does not support full SVG 1.1 \ No newline at end of file diff --git a/docs/_static/pre-commit-flow.svg b/docs/_static/pre-commit-flow.svg new file mode 100644 index 000000000..a0d663061 --- /dev/null +++ b/docs/_static/pre-commit-flow.svg @@ -0,0 +1 @@ +
`git commit -m ....`
`git commit -m ....`
Local Repository
Local Repository
Push
Push
Commit
Commit
Remote Repository
Remote Repository
Success
Success
Fail w/ console output
Fail w/ console output
pre-commit package
pre-commit package
.pre-commit.conf.yaml
.pre-commit.conf.yaml
Trigger build
Trigger build
Create Pull Request
Create Pull Request
CI/CD Workflow Tool (GitHub Actions)
CI/CD Workflow Tool...
workflow.yml
workflow.ymlViewer does not support full SVG 1.1 \ No newline at end of file