From 66536fc390ce9cdd6bb24cd8d77eb5c3ed17d4a5 Mon Sep 17 00:00:00 2001 From: Nikita Almanov <131481562+nikkeyl@users.noreply.github.com> Date: Wed, 14 Feb 2024 22:19:03 +0300 Subject: [PATCH] docs: move to `.github` repo --- .github/CODEOWNERS | 1 - .github/ISSUE_TEMPLATE/bug-report.yml | 65 -------- .github/ISSUE_TEMPLATE/docs-enhancement.yml | 29 ---- .../ISSUE_TEMPLATE/enhancement-request.yml | 38 ----- .github/PULL_REQUEST_TEMPLATE.md | 33 ---- .github/dependabot.yml | 4 +- .github/workflows/codeql.yml | 4 +- .github/workflows/eslint.yml | 8 +- .github/workflows/markdown.yml | 4 +- .github/workflows/mocha.yml | 6 +- CODE_OF_CONDUCT.md | 141 ------------------ SECURITY.md | 24 --- package.json | 4 +- 13 files changed, 16 insertions(+), 345 deletions(-) delete mode 100644 .github/CODEOWNERS delete mode 100644 .github/ISSUE_TEMPLATE/bug-report.yml delete mode 100644 .github/ISSUE_TEMPLATE/docs-enhancement.yml delete mode 100644 .github/ISSUE_TEMPLATE/enhancement-request.yml delete mode 100644 .github/PULL_REQUEST_TEMPLATE.md delete mode 100644 CODE_OF_CONDUCT.md delete mode 100644 SECURITY.md diff --git a/.github/CODEOWNERS b/.github/CODEOWNERS deleted file mode 100644 index 74ad750..0000000 --- a/.github/CODEOWNERS +++ /dev/null @@ -1 +0,0 @@ -* @nikkeyl diff --git a/.github/ISSUE_TEMPLATE/bug-report.yml b/.github/ISSUE_TEMPLATE/bug-report.yml deleted file mode 100644 index 1272cba..0000000 --- a/.github/ISSUE_TEMPLATE/bug-report.yml +++ /dev/null @@ -1,65 +0,0 @@ -name: Bug Report -description: Create a report to help us improve this project! -title: 'bug: ' -labels: - - bug -assignees: - - nikkeyl - -body: - - type: markdown - attributes: - value: Thanks for taking the time to fill out this bug report! - - - type: textarea - id: describe - attributes: - label: Describe - description: Describe what happened. - placeholder: Tell us what you see - validations: - required: true - - - type: textarea - id: reproduce - attributes: - label: Please Reproduce the Bug Step By Step - description: Please provide as much step-by-step detail as possible. - placeholder: | - 1. - 2. - 3. - validations: - required: true - - - type: textarea - id: expected - attributes: - label: Expected Behavior - description: What did you expect to happen when the reproduce steps? - placeholder: Tell us what you expected to see - validations: - required: true - - - type: textarea - id: screenshots - attributes: - label: Add Screenshots - description: Can you provide screenshots? - placeholder: Your screenshots - - - type: textarea - id: logs - attributes: - label: Relevant Log Output - description: Please copy and paste log output. No need for backticks. - placeholder: Log - render: bash - - - type: checkboxes - id: terms - attributes: - label: Code of Conduct - options: - - label: I Agree to Follow This Project's Code of Conduct - required: true diff --git a/.github/ISSUE_TEMPLATE/docs-enhancement.yml b/.github/ISSUE_TEMPLATE/docs-enhancement.yml deleted file mode 100644 index a366faf..0000000 --- a/.github/ISSUE_TEMPLATE/docs-enhancement.yml +++ /dev/null @@ -1,29 +0,0 @@ -name: Docs Enhancement -description: Create a report to help us improve this project! -title: 'docs: ' -labels: - - documentation -assignees: - - nikkeyl - -body: - - type: markdown - attributes: - value: Thanks for taking the time to fill out this docs enhancement! - - - type: textarea - id: describe - attributes: - label: Describe - description: Describe your enhancement! - placeholder: Awesome enhancement - validations: - required: true - - - type: checkboxes - id: terms - attributes: - label: Code of Conduct - options: - - label: I Agree to Follow This Project's Code of Conduct - required: true diff --git a/.github/ISSUE_TEMPLATE/enhancement-request.yml b/.github/ISSUE_TEMPLATE/enhancement-request.yml deleted file mode 100644 index 520a624..0000000 --- a/.github/ISSUE_TEMPLATE/enhancement-request.yml +++ /dev/null @@ -1,38 +0,0 @@ -name: Enhancement Request -description: Create a report to help us improve this project! -title: 'enhancement: ' -labels: - - enhancement -assignees: - - nikkeyl - -body: - - type: markdown - attributes: - value: Thanks for taking the time to fill out this enhancement request! - - - type: textarea - id: describe - attributes: - label: Describe - description: Describe your enhancement! - placeholder: Provide a step-by-step description of the suggested enhancement - validations: - required: true - - - type: textarea - id: explain - attributes: - label: Explain - description: Explain why this enhancement would be useful. - placeholder: How your enhancement could be useful - validations: - required: true - - - type: checkboxes - id: terms - attributes: - label: Code of Conduct - options: - - label: I Agree to Follow This Project's Code of Conduct - required: true diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md deleted file mode 100644 index 436b454..0000000 --- a/.github/PULL_REQUEST_TEMPLATE.md +++ /dev/null @@ -1,33 +0,0 @@ -## Pull Request template - -Please, go through these steps before you submit a **Pull Request**. - -- Make sure that your **Pull Request** is not a duplicate. - -- If not, then make sure that: - - - You have done your changes in a separate branch. - Branches MUST have descriptive names that start with either: - **`fix/`**, **`feature/`** or **`refactor/`** prefixes. - - > Example: - > - > Good: **`fix/signin-issue`**, **`feature/issue-templates`** - > or **`refactor/button`**. - - - You have a descriptive commit message with a short title (first line). - - - Make sure there are no errors in the code. - -- **After** these steps, you're ready to open a **Pull Request**. - - - Give a descriptive title to your **Pull Request**. - - - Describe your changes. - - - Put **`closes #XXXX`** in your comment to auto-close - the Issue that your **Pull Request** fixes (if such). - -IMPORTANT: Please see our **Contribution Guidelines** for details. - -**PLEASE REMOVE THIS TEMPLATE BEFORE SUBMITTING** diff --git a/.github/dependabot.yml b/.github/dependabot.yml index 90d70ee..6aa6856 100644 --- a/.github/dependabot.yml +++ b/.github/dependabot.yml @@ -5,10 +5,10 @@ updates: directory: / schedule: interval: weekly - day: sunday + day: monday - package-ecosystem: npm directory: / schedule: interval: weekly - day: sunday + day: monday diff --git a/.github/workflows/codeql.yml b/.github/workflows/codeql.yml index af5103d..bae0017 100644 --- a/.github/workflows/codeql.yml +++ b/.github/workflows/codeql.yml @@ -5,12 +5,12 @@ on: branches: - main paths: - - 'src/**/*.js' + - src/**/*.js push: branches: - main paths: - - 'src/**/*.js' + - src/**/*.js permissions: actions: read diff --git a/.github/workflows/eslint.yml b/.github/workflows/eslint.yml index 84dba7f..0199d6f 100644 --- a/.github/workflows/eslint.yml +++ b/.github/workflows/eslint.yml @@ -10,14 +10,14 @@ on: branches: - main paths: - - 'specs/**/*.js' - - 'src/**/*.js' + - specs/**/*.spec.js + - src/**/*.js push: branches: - main paths: - - 'specs/**/*.js' - - 'src/**/*.js' + - specs/**/*.spec.js + - src/**/*.js jobs: eslint: diff --git a/.github/workflows/markdown.yml b/.github/workflows/markdown.yml index 1b434c5..b16044e 100644 --- a/.github/workflows/markdown.yml +++ b/.github/workflows/markdown.yml @@ -10,12 +10,12 @@ on: branches: - main paths: - - '**/*.md' + - docs/**/*.md push: branches: - main paths: - - '**/*.md' + - docs/**/*.md jobs: markdown: diff --git a/.github/workflows/mocha.yml b/.github/workflows/mocha.yml index 5c124ab..28f54f9 100644 --- a/.github/workflows/mocha.yml +++ b/.github/workflows/mocha.yml @@ -10,12 +10,14 @@ on: branches: - main paths: - - 'src/**/*.js' + - specs/**/*.spec.js + - src/**/*.js push: branches: - main paths: - - 'src/**/*.js' + - specs/**/*.spec.js + - src/**/*.js jobs: mocha: diff --git a/CODE_OF_CONDUCT.md b/CODE_OF_CONDUCT.md deleted file mode 100644 index 5d9e31a..0000000 --- a/CODE_OF_CONDUCT.md +++ /dev/null @@ -1,141 +0,0 @@ -# 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, caste, color, 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 -[**email**](mailto:nikkeyl.dev@gmail.com). -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**](https://www.contributor-covenant.org), -version 2.1, available at -**https://www.contributor-covenant.org/version/2/1/code_of_conduct.html**. - -Community Impact Guidelines were inspired by -[**Mozilla's Code of Conduct enforcement ladder**][mozilla coc]. - -For answers to common questions about this Code of Conduct, see the **FAQ** at -[**https://www.contributor-covenant.org/faq**][faq]. -Translations are available at -[**https://www.contributor-covenant.org/translations**][translations]. - -[mozilla coc]: https://github.com/mozilla/diversity -[faq]: https://www.contributor-covenant.org/faq -[translations]: https://www.contributor-covenant.org/translations diff --git a/SECURITY.md b/SECURITY.md deleted file mode 100644 index 4b38d51..0000000 --- a/SECURITY.md +++ /dev/null @@ -1,24 +0,0 @@ -# Security Policy - -If you think you have discovered a vulnerability in this repository, -please let us know as described below. - -## Reporting Security Issues - -**Please report security vulnerabilities via -Public GitHub Issues using the `Report Security Vulnerability`**. - -Please provide the requested information below (as much as you can provide) -to help us better understand the nature and extent of the potential **Issue**: - -- Problem type -- Full paths to source files associated with the manifestation of the problem. -- Location of the affected source code (tag/branch/commit or direct URL). -- Any special configuration required to reproduce the problem. -- Step by step instructions to reproduce the problem. - -This information will help us review your report more quickly. - -## Preferred Languages - -We prefer all messages to be in English. diff --git a/package.json b/package.json index 8929491..0fcf76c 100644 --- a/package.json +++ b/package.json @@ -58,6 +58,7 @@ "stylelint": "*" }, "dependencies": { + "stylelint": "*", "stylelint-config-standard-scss": "*", "stylelint-declaration-block-no-ignored-properties": "*", "stylelint-gamut": "*", @@ -67,8 +68,7 @@ "stylelint-order": "*", "stylelint-plugin-defensive-css": "*", "stylelint-plugin-logical-css": "*", - "stylelint-prettier": "*", - "stylelint": "*" + "stylelint-prettier": "*" }, "devDependencies": { "@commitlint/cli": "*",