Skip to content

Commit da2a3b9

Browse files
StephanGerbethStephanGerbeth
authored
Merge pull request #43 from basics/feature/info
Feature/info
2 parents 1d8a341 + 6b68482 commit da2a3b9

File tree

7 files changed

+327
-28
lines changed

7 files changed

+327
-28
lines changed

‎.gitattributes

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
* text=auto

‎.github/ISSUE_TEMPLATE/bug_report.md

Lines changed: 38 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,38 @@
1+
---
2+
name: Bug report
3+
about: Create a report to help us improve
4+
title: ''
5+
labels: ''
6+
assignees: ''
7+
8+
---
9+
10+
**Describe the bug**
11+
A clear and concise description of what the bug is.
12+
13+
**To Reproduce**
14+
Steps to reproduce the behavior:
15+
1. Go to '...'
16+
2. Click on '....'
17+
3. Scroll down to '....'
18+
4. See error
19+
20+
**Expected behavior**
21+
A clear and concise description of what you expected to happen.
22+
23+
**Screenshots**
24+
If applicable, add screenshots to help explain your problem.
25+
26+
**Desktop (please complete the following information):**
27+
- OS: [e.g. iOS]
28+
- Browser [e.g. chrome, safari]
29+
- Version [e.g. 22]
30+
31+
**Smartphone (please complete the following information):**
32+
- Device: [e.g. iPhone6]
33+
- OS: [e.g. iOS8.1]
34+
- Browser [e.g. stock browser, safari]
35+
- Version [e.g. 22]
36+
37+
**Additional context**
38+
Add any other context about the problem here.

‎.github/ISSUE_TEMPLATE/feature_request.md

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
---
2+
name: Feature request
3+
about: Suggest an idea for this project
4+
title: ''
5+
labels: ''
6+
assignees: ''
7+
8+
---
9+
10+
**Is your feature request related to a problem? Please describe.**
11+
A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
12+
13+
**Describe the solution you'd like**
14+
A clear and concise description of what you want to happen.
15+
16+
**Describe alternatives you've considered**
17+
A clear and concise description of any alternative solutions or features you've considered.
18+
19+
**Additional context**
20+
Add any other context or screenshots about the feature request here.

‎.github/pull_request_template.md

Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
1+
* **Please check if the PR fulfills these requirements**
2+
- [ ] The commit message follows our guidelines
3+
- [ ] Tests for the changes have been added (for bug fixes / features)
4+
- [ ] Docs have been added / updated (for bug fixes / features)
5+
6+
7+
* **What kind of change does this PR introduce?** (Bug fix, feature, docs update, ...)
8+
9+
10+
11+
* **What is the current behavior?** (You can also link to an open issue here)
12+
13+
14+
15+
* **What is the new behavior (if this is a feature change)?**
16+
17+
18+
19+
* **Does this PR introduce a breaking change?** (What changes might users need to make in their application due to this PR?)
20+
21+
22+
23+
* **Other information**:

‎.vscode/launch.json

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
1+
{
2+
"version": "0.2.0",
3+
"configurations": [
4+
{
5+
"type": "node",
6+
"request": "launch",
7+
"name": "Debug Current Test File",
8+
"autoAttachChildProcesses": true,
9+
"skipFiles": [
10+
"<node_internals>/**",
11+
"**/node_modules/**"
12+
],
13+
"program": "${workspaceRoot}/node_modules/vitest/vitest.mjs",
14+
"args": [
15+
"run",
16+
"${relativeFile}"
17+
],
18+
"smartStep": true,
19+
"console": "integratedTerminal"
20+
}
21+
]
22+
}

‎CODE_OF_CONDUCT.md

Lines changed: 133 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,133 @@
1+
2+
# Contributor Covenant Code of Conduct
3+
4+
## Our Pledge
5+
6+
We as members, contributors, and leaders pledge to make participation in our
7+
community a harassment-free experience for everyone, regardless of age, body
8+
size, visible or invisible disability, ethnicity, sex characteristics, gender
9+
identity and expression, level of experience, education, socio-economic status,
10+
nationality, personal appearance, race, caste, color, religion, or sexual
11+
identity and orientation.
12+
13+
We pledge to act and interact in ways that contribute to an open, welcoming,
14+
diverse, inclusive, and healthy community.
15+
16+
## Our Standards
17+
18+
Examples of behavior that contributes to a positive environment for our
19+
community include:
20+
21+
* Demonstrating empathy and kindness toward other people
22+
* Being respectful of differing opinions, viewpoints, and experiences
23+
* Giving and gracefully accepting constructive feedback
24+
* Accepting responsibility and apologizing to those affected by our mistakes,
25+
and learning from the experience
26+
* Focusing on what is best not just for us as individuals, but for the overall
27+
community
28+
29+
Examples of unacceptable behavior include:
30+
31+
* The use of sexualized language or imagery, and sexual attention or advances of
32+
any kind
33+
* Trolling, insulting or derogatory comments, and personal or political attacks
34+
* Public or private harassment
35+
* Publishing others' private information, such as a physical or email address,
36+
without their explicit permission
37+
* Other conduct which could reasonably be considered inappropriate in a
38+
professional setting
39+
40+
## Enforcement Responsibilities
41+
42+
Community leaders are responsible for clarifying and enforcing our standards of
43+
acceptable behavior and will take appropriate and fair corrective action in
44+
response to any behavior that they deem inappropriate, threatening, offensive,
45+
or harmful.
46+
47+
Community leaders have the right and responsibility to remove, edit, or reject
48+
comments, commits, code, wiki edits, issues, and other contributions that are
49+
not aligned to this Code of Conduct, and will communicate reasons for moderation
50+
decisions when appropriate.
51+
52+
## Scope
53+
54+
This Code of Conduct applies within all community spaces, and also applies when
55+
an individual is officially representing the community in public spaces.
56+
Examples of representing our community include using an official email address,
57+
posting via an official social media account, or acting as an appointed
58+
representative at an online or offline event.
59+
60+
## Enforcement
61+
62+
Instances of abusive, harassing, or otherwise unacceptable behavior may be
63+
reported to the community leaders responsible for enforcement at
64+
[INSERT CONTACT METHOD].
65+
All complaints will be reviewed and investigated promptly and fairly.
66+
67+
All community leaders are obligated to respect the privacy and security of the
68+
reporter of any incident.
69+
70+
## Enforcement Guidelines
71+
72+
Community leaders will follow these Community Impact Guidelines in determining
73+
the consequences for any action they deem in violation of this Code of Conduct:
74+
75+
### 1. Correction
76+
77+
**Community Impact**: Use of inappropriate language or other behavior deemed
78+
unprofessional or unwelcome in the community.
79+
80+
**Consequence**: A private, written warning from community leaders, providing
81+
clarity around the nature of the violation and an explanation of why the
82+
behavior was inappropriate. A public apology may be requested.
83+
84+
### 2. Warning
85+
86+
**Community Impact**: A violation through a single incident or series of
87+
actions.
88+
89+
**Consequence**: A warning with consequences for continued behavior. No
90+
interaction with the people involved, including unsolicited interaction with
91+
those enforcing the Code of Conduct, for a specified period of time. This
92+
includes avoiding interactions in community spaces as well as external channels
93+
like social media. Violating these terms may lead to a temporary or permanent
94+
ban.
95+
96+
### 3. Temporary Ban
97+
98+
**Community Impact**: A serious violation of community standards, including
99+
sustained inappropriate behavior.
100+
101+
**Consequence**: A temporary ban from any sort of interaction or public
102+
communication with the community for a specified period of time. No public or
103+
private interaction with the people involved, including unsolicited interaction
104+
with those enforcing the Code of Conduct, is allowed during this period.
105+
Violating these terms may lead to a permanent ban.
106+
107+
### 4. Permanent Ban
108+
109+
**Community Impact**: Demonstrating a pattern of violation of community
110+
standards, including sustained inappropriate behavior, harassment of an
111+
individual, or aggression toward or disparagement of classes of individuals.
112+
113+
**Consequence**: A permanent ban from any sort of public interaction within the
114+
community.
115+
116+
## Attribution
117+
118+
This Code of Conduct is adapted from the [Contributor Covenant][homepage],
119+
version 2.1, available at
120+
[https://www.contributor-covenant.org/version/2/1/code_of_conduct.html][v2.1].
121+
122+
Community Impact Guidelines were inspired by
123+
[Mozilla's code of conduct enforcement ladder][Mozilla CoC].
124+
125+
For answers to common questions about this code of conduct, see the FAQ at
126+
[https://www.contributor-covenant.org/faq][FAQ]. Translations are available at
127+
[https://www.contributor-covenant.org/translations][translations].
128+
129+
[homepage]: https://www.contributor-covenant.org
130+
[v2.1]: https://www.contributor-covenant.org/version/2/1/code_of_conduct.html
131+
[Mozilla CoC]: https://github.com/mozilla/diversity
132+
[FAQ]: https://www.contributor-covenant.org/faq
133+
[translations]: https://www.contributor-covenant.org/translations

‎README.md

Lines changed: 90 additions & 28 deletions
Original file line numberDiff line numberDiff line change
@@ -15,40 +15,102 @@
1515
---
1616

1717
## ToDo
18-
- evaluation
19-
- [ ] BranchNameLint alternative (https://www.npmjs.com/package/branch-name-lint)
20-
- [ ] SonarLint (https://docs.sonarsource.com/sonarcloud/improving/sonarlint/)
21-
- [ ] ...
22-
- observables + test
23-
- [ ] default fetch
24-
- [ ] window dom (resize, scroll)?
18+
19+
20+
- project config
21+
- monorepo
22+
- [x] create project structure
23+
- [x] add package.json and correct package namings
24+
- editor
25+
- [x] consistent code styles (editorconfig)
26+
- [x] normalize eof (gitattributes)
27+
- [x] autofix syntax errors (eslint)
28+
- [x] autofix code formatting (prettier)
29+
- vscode
30+
- [x] created workspace file with default settings
31+
- [x] added launch configuration
32+
- [x] run debugger mode for custom opened test file
33+
- [ ] ...
34+
- [x] added extension recommendation (will be installed, when project will be opened by workspace file)
35+
- [x] evaluate SonarLint (https://docs.sonarsource.com/sonarcloud/improving/sonarlint/)
36+
- [ ] ...
37+
- node
38+
- [x] node version manager support (nvmrc)
39+
- [x] defined current node version (20)
40+
- [x] package manager bot (renovate)
41+
- info
42+
- [x] added code of conduct
43+
- [x] added licence (MIT)
44+
- versioning
45+
- [x] monorepo support
46+
- [x] pre(release) support
47+
- [x] added commit-analyzer
48+
- [x] added release notes generator
49+
- [x] added changelog generator
50+
- [x] added optional npm publishing process
51+
- [x] added git update process to commit new version and notes
52+
- [x] added github update process to publish new version and notes
53+
- vitest
54+
- [x] monorepo support
55+
- [x] run tests with hot reload
56+
- [x] run code coverage analysis
57+
- [x] create reports (html, lcov, text)
58+
- [x] implemented test samples
59+
- [x] mock browser events (with marble definitions)
60+
- [x] mock requests (with marble definition)
61+
- [x] true async handling
62+
- browserslist
63+
- [x] embedded but currently not needed
64+
- git
65+
- [x] lint commit messages (commitlint)
66+
- [x] Run linters against staged git files (lint-stage)
67+
- [x] ignore files/dirs for versioning (gitignore)
68+
- [ ] evaluate BranchNameLint alternative (https://www.npmjs.com/package/branch-name-lint)
69+
- github
70+
- config
71+
- [x] added to organization
72+
- [x] protected branch remove of main
73+
- [x] protected branch remove of beta
74+
- [ ]
75+
- actions
76+
- pipelines
77+
- [x] main
78+
- [x] beta
79+
- [x] feature
80+
- [x] deploy coverage report of main branch to gh-pages
81+
- [ ] ...
82+
- tasks
83+
- [x] versioning
84+
- [x] test
85+
- [x] code analysis
86+
- [ ] evaluate pr agent
87+
- [ ] ...
88+
- rules
89+
- [ ] main branch can be updated only by pull request from
90+
- [ ] beta branch
91+
- [ ] hotfix branch
92+
- [ ] beta branch can be updated only by pull request from
93+
- [ ] feature branch
94+
- [ ] hotfix branch
95+
- [ ] ...
96+
- SonarCloud
97+
- [x] account created
98+
- [x] embedded analysis call into each git-action as task
99+
- [x] created sonarcloud properties in repo to publish on demand config
100+
- [x] proof working code analysis for main
101+
- [x] proof working code analysis for beta
102+
- project code
103+
- observables + test
104+
- [ ] finalize default fetch
105+
- [ ] create & finalize window dom (resize, scroll)?
25106
- [ ] ...
26107
- operators + test
27108
- [ ] finalize network retry
28-
- [ ] request paginator (full, lazy)
29-
- [ ] ...
30-
<!-- - git actions
31-
- [ ] implemented merge strategy
32-
- only beta-branch can be merged into main
33-
- only feature-branches can be merged into beta
34-
- hotfixes can be merged directly into main, but beta will also be updated
35-
- [ ] ... -->
36-
- git rules
37-
- [ ] main branch can be updated only by pull request from
38-
- [ ] beta branch
39-
- [ ] hotfix branch
40-
- [ ] beta branch can be updated only by pull request from
41-
- [ ] feature branch
42-
- [ ] hotfix branch
43-
- sonarcloud
44-
- [ ] finalized config
45-
- [ ] ...
46-
- additional git action services
47-
- [ ] evaluate pr agent
48-
- [ ] ...
109+
- [ ] create & finalize request paginator (full, lazy)
49110
- [ ] ...
50111

51112

113+
52114
[renovate-status-src]: <https://img.shields.io/badge/renovate-enabled-brightgreen>
53115
[renovate-status-href]: <https://renovate.whitesourcesoftware.com/>
54116

0 commit comments

Comments
 (0)