fix docs

diff --git a/CODE_OF_CONDUCT.md b/CODE_OF_CONDUCT.md
deleted file mode 100644 (file)
index 09be2b7..0000000
--- a/CODE_OF_CONDUCT.md
+++ /dev/null
@@ -1 +0,0 @@
-See Code-of-Conduct --> https://github.com/CommentGeneratorCollection/CommentGenerator-Electron/wiki/Code-of-Conduct

diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
deleted file mode 100644 (file)
index 10a873d..0000000
--- a/CONTRIBUTING.md
+++ /dev/null
@@ -1 +0,0 @@
-See Contributing --> https://github.com/CommentGeneratorCollection/CommentGenerator-Electron/wiki/Contributing

diff --git a/SECURITY.md b/SECURITY.md
deleted file mode 100644 (file)
index f047450..0000000
--- a/SECURITY.md
+++ /dev/null
@@ -1 +0,0 @@
-See Security-Policy --> https://github.com/CommentGeneratorCollection/CommentGenerator-Electron/wiki/Security-Policy

diff --git a/CHANGELOG.md b/docs/CHANGELOG.md
similarity index 100%
rename from CHANGELOG.md
rename to docs/CHANGELOG.md

diff --git a/docs/CODE_OF_CONDUCT.md b/docs/CODE_OF_CONDUCT.md
new file mode 100644 (file)
index 0000000..180a3b3
--- /dev/null
+++ b/docs/CODE_OF_CONDUCT.md
@@ -0,0 +1,128 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+We as members, contributors, and leaders pledge to make participation in our
+community a harassment-free experience for everyone, regardless of age, body
+size, visible or invisible disability, ethnicity, sex characteristics, gender
+identity and expression, level of experience, education, socio-economic status,
+nationality, personal appearance, race, religion, or sexual identity
+and orientation.
+
+We pledge to act and interact in ways that contribute to an open, welcoming,
+diverse, inclusive, and healthy community.
+
+## Our Standards
+
+Examples of behavior that contributes to a positive environment for our
+community include:
+
+* Demonstrating empathy and kindness toward other people
+* Being respectful of differing opinions, viewpoints, and experiences
+* Giving and gracefully accepting constructive feedback
+* Accepting responsibility and apologizing to those affected by our mistakes,
+  and learning from the experience
+* Focusing on what is best not just for us as individuals, but for the
+  overall community
+
+Examples of unacceptable behavior include:
+
+* The use of sexualized language or imagery, and sexual attention or
+  advances of any kind
+* Trolling, insulting or derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or email
+  address, without their explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Enforcement Responsibilities
+
+Community leaders are responsible for clarifying and enforcing our standards of
+acceptable behavior and will take appropriate and fair corrective action in
+response to any behavior that they deem inappropriate, threatening, offensive,
+or harmful.
+
+Community leaders have the right and responsibility to remove, edit, or reject
+comments, commits, code, wiki edits, issues, and other contributions that are
+not aligned to this Code of Conduct, and will communicate reasons for moderation
+decisions when appropriate.
+
+## Scope
+
+This Code of Conduct applies within all community spaces, and also applies when
+an individual is officially representing the community in public spaces.
+Examples of representing our community include using an official e-mail address,
+posting via an official social media account, or acting as an appointed
+representative at an online or offline event.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported to the community leaders responsible for enforcement at
+"Twitter(@Neko7sora) DM".
+All complaints will be reviewed and investigated promptly and fairly.
+
+All community leaders are obligated to respect the privacy and security of the
+reporter of any incident.
+
+## Enforcement Guidelines
+
+Community leaders will follow these Community Impact Guidelines in determining
+the consequences for any action they deem in violation of this Code of Conduct:
+
+### 1. Correction
+
+**Community Impact**: Use of inappropriate language or other behavior deemed
+unprofessional or unwelcome in the community.
+
+**Consequence**: A private, written warning from community leaders, providing
+clarity around the nature of the violation and an explanation of why the
+behavior was inappropriate. A public apology may be requested.
+
+### 2. Warning
+
+**Community Impact**: A violation through a single incident or series
+of actions.
+
+**Consequence**: A warning with consequences for continued behavior. No
+interaction with the people involved, including unsolicited interaction with
+those enforcing the Code of Conduct, for a specified period of time. This
+includes avoiding interactions in community spaces as well as external channels
+like social media. Violating these terms may lead to a temporary or
+permanent ban.
+
+### 3. Temporary Ban
+
+**Community Impact**: A serious violation of community standards, including
+sustained inappropriate behavior.
+
+**Consequence**: A temporary ban from any sort of interaction or public
+communication with the community for a specified period of time. No public or
+private interaction with the people involved, including unsolicited interaction
+with those enforcing the Code of Conduct, is allowed during this period.
+Violating these terms may lead to a permanent ban.
+
+### 4. Permanent Ban
+
+**Community Impact**: Demonstrating a pattern of violation of community
+standards, including sustained inappropriate behavior,  harassment of an
+individual, or aggression toward or disparagement of classes of individuals.
+
+**Consequence**: A permanent ban from any sort of public interaction within
+the community.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage],
+version 2.0, available at
+https://www.contributor-covenant.org/version/2/0/code_of_conduct.html.
+
+Community Impact Guidelines were inspired by [Mozilla's code of conduct
+enforcement ladder](https://github.com/mozilla/diversity).
+
+[homepage]: https://www.contributor-covenant.org
+
+For answers to common questions about this code of conduct, see the FAQ at
+https://www.contributor-covenant.org/faq. Translations are available at
+https://www.contributor-covenant.org/translations.

diff --git a/docs/CONTRIBUTING.md b/docs/CONTRIBUTING.md
new file mode 100644 (file)
index 0000000..3c6e422
--- /dev/null
+++ b/docs/CONTRIBUTING.md
@@ -0,0 +1,18 @@
+# Contributing Guide
+
+## How to contribute?
+
+You can find problems from Issues or fix other problems.
+
+Basic Pull Request steps:
+
+1. Fork this repository
+
+2. Global uninstall yarn pnpm: `npm uninstall -g yarn pnpm`
+3. Global install corepack: `npm install -g corepack`
+
+   See also --> https://github.com/nodejs/corepack
+4. Create your feature branch: `git checkout -b awesome-feature`
+5. Commit your changes: `git commit -am "Add awesome feature"`
+6. Push to the branch: `git push origin awesome-feature`
+7. Submit a pull request to this repository

diff --git a/README.md b/docs/README.md
similarity index 100%
rename from README.md
rename to docs/README.md

diff --git a/docs/SECURITY.md b/docs/SECURITY.md
new file mode 100644 (file)
index 0000000..d499c26
--- /dev/null
+++ b/docs/SECURITY.md
@@ -0,0 +1,47 @@
+# Security Policy
+
+If you believe you have found a security vulnerability in `CommentGenerator-Electron` repository, please report it to us as described below.
+
+## Supported Versions
+This is the list of versions of `CommentGenerator-Electron` which are
+currently being supported with security updates.
+
+| Version  | Supported |
+| ------  | ------- |
+| 1.x.x   | ❓ |
+| < 0.x.x | ⚠️ |
+
+✅ ❌ ⚠️ ❓
+
+## Reporting Security Issues
+**Please do not report security vulnerabilities through public GitHub issues.**
+
+Instead, please report them to "Reporting Security Issues Powered by GitLab Service desk" at `contact-project+commentgeneratorcollection-security-issues✨incoming.gitlab.com` ( ✨ → ＠ )
+
+Please include the requested information listed below (as much as you can provide) to help us better understand the nature and scope of the possible issue:
+
+* Organization & Repository name `CommentGeneratorCollection/CommentGenerator-Electron`
+* Type of issue (e.g. buffer overflow, SQL injection, cross-site scripting, etc.)
+* Full paths of source file(s) related to the manifestation of the issue
+* The location of the affected source code (tag/branch/commit or direct URL)
+* Any special configuration required to reproduce the issue
+* Step-by-step instructions to reproduce the issue
+* Proof-of-concept or exploit code (if possible)
+* Impact of the issue, including how an attacker might exploit the issue
+
+This information will help us triage your report more quickly.
+
+## Preferred Languages
+We prefer all communications to be in Japanese.
+
+---
+
+## Powered by GitLab Service desk
+<img align="left" src="https://gitlab.com/uploads/-/system/project/avatar/28146194/2021-01-07__27__-_%E3%82%B3%E3%83%94%E3%83%BC.png?width=64" />
+
+```
+Reporting Security Issues | Project ID: 28146194
+https://gitlab.com/CommentGeneratorCollection/SECURITY
+```
+
+---