From 0a5ed64c21daa96c1936f4e94566138e940b426a Mon Sep 17 00:00:00 2001 From: StephanGerbeth Date: Wed, 18 Sep 2024 09:44:48 +0200 Subject: [PATCH 1/3] chore(markdown): added code of conduct and github issue and pull request templates --- .github/ISSUE_TEMPLATE/bug_report.md | 38 +++++++ .github/ISSUE_TEMPLATE/feature_request.md | 20 ++++ .github/pull_request_template.md | 23 ++++ CODE_OF_CONDUCT.md | 133 ++++++++++++++++++++++ README.md | 7 +- 5 files changed, 215 insertions(+), 6 deletions(-) create mode 100644 .github/ISSUE_TEMPLATE/bug_report.md create mode 100644 .github/ISSUE_TEMPLATE/feature_request.md create mode 100644 .github/pull_request_template.md create mode 100644 CODE_OF_CONDUCT.md diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md new file mode 100644 index 0000000..272cbd7 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug_report.md @@ -0,0 +1,38 @@ +--- +name: Bug report +about: Create a report to help us improve +title: '' +labels: '' +assignees: '' + +--- + +**Describe the bug** +A clear and concise description of what the bug is. + +**To Reproduce** +Steps to reproduce the behavior: +1. Go to '...' +2. Click on '....' +3. Scroll down to '....' +4. See error + +**Expected behavior** +A clear and concise description of what you expected to happen. + +**Screenshots** +If applicable, add screenshots to help explain your problem. + +**Desktop (please complete the following information):** + - OS: [e.g. iOS] + - Browser [e.g. chrome, safari] + - Version [e.g. 22] + +**Smartphone (please complete the following information):** + - Device: [e.g. iPhone6] + - OS: [e.g. iOS8.1] + - Browser [e.g. stock browser, safari] + - Version [e.g. 22] + +**Additional context** +Add any other context about the problem here. \ No newline at end of file diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md new file mode 100644 index 0000000..24473de --- /dev/null +++ b/.github/ISSUE_TEMPLATE/feature_request.md @@ -0,0 +1,20 @@ +--- +name: Feature request +about: Suggest an idea for this project +title: '' +labels: '' +assignees: '' + +--- + +**Is your feature request related to a problem? Please describe.** +A clear and concise description of what the problem is. Ex. I'm always frustrated when [...] + +**Describe the solution you'd like** +A clear and concise description of what you want to happen. + +**Describe alternatives you've considered** +A clear and concise description of any alternative solutions or features you've considered. + +**Additional context** +Add any other context or screenshots about the feature request here. \ No newline at end of file diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md new file mode 100644 index 0000000..ada5359 --- /dev/null +++ b/.github/pull_request_template.md @@ -0,0 +1,23 @@ +* **Please check if the PR fulfills these requirements** +- [ ] The commit message follows our guidelines +- [ ] Tests for the changes have been added (for bug fixes / features) +- [ ] Docs have been added / updated (for bug fixes / features) + + +* **What kind of change does this PR introduce?** (Bug fix, feature, docs update, ...) + + + +* **What is the current behavior?** (You can also link to an open issue here) + + + +* **What is the new behavior (if this is a feature change)?** + + + +* **Does this PR introduce a breaking change?** (What changes might users need to make in their application due to this PR?) + + + +* **Other information**: \ No newline at end of file diff --git a/CODE_OF_CONDUCT.md b/CODE_OF_CONDUCT.md new file mode 100644 index 0000000..20bcc4f --- /dev/null +++ b/CODE_OF_CONDUCT.md @@ -0,0 +1,133 @@ + +# 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, 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 email 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 +[INSERT CONTACT METHOD]. +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.1, available at +[https://www.contributor-covenant.org/version/2/1/code_of_conduct.html][v2.1]. + +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]. + +[homepage]: https://www.contributor-covenant.org +[v2.1]: https://www.contributor-covenant.org/version/2/1/code_of_conduct.html +[Mozilla CoC]: https://github.com/mozilla/diversity +[FAQ]: https://www.contributor-covenant.org/faq +[translations]: https://www.contributor-covenant.org/translations diff --git a/README.md b/README.md index b706ff0..8101b32 100644 --- a/README.md +++ b/README.md @@ -27,12 +27,6 @@ - [ ] finalize network retry - [ ] request paginator (full, lazy) - [ ] ... - - git rules - [ ] main branch can be updated only by pull request from - [ ] beta branch @@ -40,6 +34,7 @@ - [ ] beta branch can be updated only by pull request from - [ ] feature branch - [ ] hotfix branch + - [ ] ... - sonarcloud - [ ] finalized config - [ ] ... From 79c39cce29a848cda03985f2ff04a06e88885988 Mon Sep 17 00:00:00 2001 From: StephanGerbeth Date: Wed, 18 Sep 2024 10:05:14 +0200 Subject: [PATCH 2/3] fix(launch): added procedure to test current test file --- .vscode/launch.json | 22 ++++++++++++++++++++++ 1 file changed, 22 insertions(+) create mode 100644 .vscode/launch.json diff --git a/.vscode/launch.json b/.vscode/launch.json new file mode 100644 index 0000000..968e297 --- /dev/null +++ b/.vscode/launch.json @@ -0,0 +1,22 @@ +{ + "version": "0.2.0", + "configurations": [ + { + "type": "node", + "request": "launch", + "name": "Debug Current Test File", + "autoAttachChildProcesses": true, + "skipFiles": [ + "/**", + "**/node_modules/**" + ], + "program": "${workspaceRoot}/node_modules/vitest/vitest.mjs", + "args": [ + "run", + "${relativeFile}" + ], + "smartStep": true, + "console": "integratedTerminal" + } + ] +} From 6b6848221cf36c56a1e099b86f611e9b793c0693 Mon Sep 17 00:00:00 2001 From: StephanGerbeth Date: Wed, 18 Sep 2024 13:20:12 +0200 Subject: [PATCH 3/3] fix(readme): added solved and open todos --- .gitattributes | 1 + README.md | 113 +++++++++++++++++++++++++++++++++++++++---------- 2 files changed, 91 insertions(+), 23 deletions(-) create mode 100644 .gitattributes diff --git a/.gitattributes b/.gitattributes new file mode 100644 index 0000000..176a458 --- /dev/null +++ b/.gitattributes @@ -0,0 +1 @@ +* text=auto diff --git a/README.md b/README.md index 8101b32..08e5e2a 100644 --- a/README.md +++ b/README.md @@ -15,35 +15,102 @@ --- ## ToDo -- evaluation - - [ ] BranchNameLint alternative (https://www.npmjs.com/package/branch-name-lint) - - [ ] SonarLint (https://docs.sonarsource.com/sonarcloud/improving/sonarlint/) - - [ ] ... -- observables + test - - [ ] default fetch - - [ ] window dom (resize, scroll)? + + +- project config + - monorepo + - [x] create project structure + - [x] add package.json and correct package namings + - editor + - [x] consistent code styles (editorconfig) + - [x] normalize eof (gitattributes) + - [x] autofix syntax errors (eslint) + - [x] autofix code formatting (prettier) + - vscode + - [x] created workspace file with default settings + - [x] added launch configuration + - [x] run debugger mode for custom opened test file + - [ ] ... + - [x] added extension recommendation (will be installed, when project will be opened by workspace file) + - [x] evaluate SonarLint (https://docs.sonarsource.com/sonarcloud/improving/sonarlint/) + - [ ] ... + - node + - [x] node version manager support (nvmrc) + - [x] defined current node version (20) + - [x] package manager bot (renovate) + - info + - [x] added code of conduct + - [x] added licence (MIT) + - versioning + - [x] monorepo support + - [x] pre(release) support + - [x] added commit-analyzer + - [x] added release notes generator + - [x] added changelog generator + - [x] added optional npm publishing process + - [x] added git update process to commit new version and notes + - [x] added github update process to publish new version and notes + - vitest + - [x] monorepo support + - [x] run tests with hot reload + - [x] run code coverage analysis + - [x] create reports (html, lcov, text) + - [x] implemented test samples + - [x] mock browser events (with marble definitions) + - [x] mock requests (with marble definition) + - [x] true async handling + - browserslist + - [x] embedded but currently not needed + - git + - [x] lint commit messages (commitlint) + - [x] Run linters against staged git files (lint-stage) + - [x] ignore files/dirs for versioning (gitignore) + - [ ] evaluate BranchNameLint alternative (https://www.npmjs.com/package/branch-name-lint) + - github + - config + - [x] added to organization + - [x] protected branch remove of main + - [x] protected branch remove of beta + - [ ] + - actions + - pipelines + - [x] main + - [x] beta + - [x] feature + - [x] deploy coverage report of main branch to gh-pages + - [ ] ... + - tasks + - [x] versioning + - [x] test + - [x] code analysis + - [ ] evaluate pr agent + - [ ] ... + - rules + - [ ] main branch can be updated only by pull request from + - [ ] beta branch + - [ ] hotfix branch + - [ ] beta branch can be updated only by pull request from + - [ ] feature branch + - [ ] hotfix branch + - [ ] ... + - SonarCloud + - [x] account created + - [x] embedded analysis call into each git-action as task + - [x] created sonarcloud properties in repo to publish on demand config + - [x] proof working code analysis for main + - [x] proof working code analysis for beta +- project code + - observables + test + - [ ] finalize default fetch + - [ ] create & finalize window dom (resize, scroll)? - [ ] ... - operators + test - [ ] finalize network retry - - [ ] request paginator (full, lazy) - - [ ] ... -- git rules - - [ ] main branch can be updated only by pull request from - - [ ] beta branch - - [ ] hotfix branch - - [ ] beta branch can be updated only by pull request from - - [ ] feature branch - - [ ] hotfix branch - - [ ] ... -- sonarcloud - - [ ] finalized config - - [ ] ... -- additional git action services - - [ ] evaluate pr agent - - [ ] ... + - [ ] create & finalize request paginator (full, lazy) - [ ] ... + [renovate-status-src]: [renovate-status-href]: