Skip to content

Commit 35ace2f

Browse files
author
ADMSK\AVROGAL1
committed
docs: updates on workflows
Added information on documentation
1 parent 43cf38c commit 35ace2f

26 files changed

+505
-280
lines changed

.editorconfig

+1-1
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@ indent_size = 2
2424
indent_size = 4
2525

2626
[*.{css, scss, json}]
27-
indent_size = 2
27+
indent_size = 4
2828

2929
[*.{md, markdown}]
3030
max_line_length = off

.husky/pre-commit

+3-2
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,11 @@
11
#!/bin/sh
22
. "$(dirname "$0")/_/husky.sh"
33

4-
# npm run lint:staged
5-
# npm run all
4+
npm run lint:staged
5+
npm run all
66
npm run changelog
77

88
git add docs/
99

10+
git add README.md
1011
git add CHANGELOG.md

.lintstagedrc.json

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,3 @@
11
{
2-
"*.{json,md}": "prettier --write"
2+
"*.{json,md,yaml,yml}": "prettier --write --ignore-unknown"
33
}

.prettierignore

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,11 @@
11
*.log
22
*.DS_Store
3-
*.md
43

54
.github
65
.dependabot
76
.idea
87
.vscode
8+
.husky
99

1010
node_modules
1111
flow-typed

.prettierrc.yaml

+7-2
Original file line numberDiff line numberDiff line change
@@ -12,20 +12,25 @@ bracketSpacing: true
1212
jsxBracketSameLine: true
1313
arrowParens: 'avoid'
1414
proseWrap: 'always'
15-
parser: typescript
1615
overrides:
1716
- files:
1817
- '*.html'
1918
- 'legacy/**/*.js'
2019
options:
2120
semi: true
21+
- files: '**/*.json*'
22+
options:
23+
parser: json
24+
proseWrap: 'always'
2225
- files: '**/*.md*'
2326
options:
27+
parser: markdown
2428
proseWrap: 'always'
25-
printWidth: 80
2629
- files: '**/*.{yaml,yml}*'
2730
options:
31+
parser: yaml
2832
tabWidth: 2
33+
printWidth: 80
2934
- files: '**/.all-(contributorsrc|membersrc|sponsorsrc)'
3035
options:
3136
parser: 'json-stringify'

OSSMETADATA

+1
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
(osslifecycle = active)

README.md

+15-11
Original file line numberDiff line numberDiff line change
@@ -37,6 +37,7 @@
3737
[![ComVer](https://img.shields.io/badge/ComVer-compliant-brightgreen.svg)][tags]
3838
[![GitHub Super-Linter](https://github.com/alexrogalskiy/java-patterns/workflows/Lint%20Code%20Base/badge.svg)](https://github.com/marketplace/actions/super-linter)
3939
[![Documentation Status](https://readthedocs.org/projects/java-patterns/badge/?version=latest)](https://java-patterns.readthedocs.io/en/latest/?badge=latest)
40+
[![NetflixOSS Lifecycle](https://img.shields.io/osslifecycle/AlexRogalskiy/java-patterns.svg)]()
4041

4142
## 🎹 *Table of contents*
4243

@@ -87,7 +88,8 @@
8788
</a>
8889
</p>
8990

90-
***Java Design Patterns*** is intended to provide various use case scenarios and architectural concepts on prototyping adaptive applications.
91+
***Java Design Patterns*** is intended to provide various use case scenarios and architectural concepts on
92+
prototyping adaptive applications.
9193

9294
```text
9395
mkdocs.yml # Configuration file.
@@ -97,12 +99,12 @@ docs/
9799
units/
98100
design-patterns.md # Design patterns and architectural concepts
99101
scenarios.md # Scenarios in practice
100-
use-cases.md # Typical use cases
102+
use-cases.md # Typical use cases
101103
user-guide/
102-
changelog.md # Changelog page
103-
code_of_conduct.md # Code of conduct page
104-
code_owners.md # Code owners page
105-
dependency.md # Dependency page
104+
changelog.md # Changelog page
105+
code_of_conduct.md # Code of conduct page
106+
code_owners.md # Code owners page
107+
dependency.md # Dependency page
106108
description.md # Description page
107109
faq.md # FAQ page
108110
getting-started.md # Getting started page
@@ -183,7 +185,8 @@ mkdocs --verbose gh-deploy --force --remote-branch gh-pages
183185

184186
## 📝 *Versioning*
185187

186-
The project uses [SemVer](http://semver.org/) for versioning. For the versions available, see the [tags on this repository][tags].
188+
The project uses [SemVer](http://semver.org/) for versioning. For the versions available, see the [tags on
189+
this repository][tags].
187190

188191
## 🌹 *Authors*
189192

@@ -198,8 +201,8 @@ with community support please contact with us if you have some question or propo
198201
[![Contributors Display](https://badges.pufler.dev/contributors/AlexRogalskiy/java-patterns?size=50\&padding=5\&bots=true)](https://badges.pufler.dev)
199202

200203
Please read
201-
[CONTRIBUTING.md](https://github.com/AlexRogalskiy/java-patterns/blob/master/.github/CONTRIBUTING.md)
202-
for details on our code of conduct, and the process for submitting pull requests to us
204+
[CONTRIBUTING.md](https://github.com/AlexRogalskiy/java-patterns/blob/master/.github/CONTRIBUTING.md) for
205+
details on our code of conduct, and the process for submitting pull requests to us
203206
([emoji key](https://allcontributors.org/docs/en/emoji-key)).
204207

205208
This project follows the [all-contributors](https://github.com/all-contributors/all-contributors)
@@ -220,8 +223,9 @@ See also the list of [contributors][contributors] who participated in this proje
220223

221224
## *Licensing*
222225

223-
***Java Patterns*** is distributed under LGPL version 3 or later, \[[License](https://github.com/AlexRogalskiy/java-patterns/blob/master/LICENSE.txt)].
224-
LGPLv3 is additional permissions on top of GPLv3.
226+
***Java Patterns*** is distributed under LGPL version 3 or later,
227+
\[[License](https://github.com/AlexRogalskiy/java-patterns/blob/master/LICENSE.txt)]. LGPLv3 is additional
228+
permissions on top of GPLv3.
225229

226230
![image](https://user-images.githubusercontent.com/19885116/48661948-6cf97e80-ea7a-11e8-97e7-b45332a13e49.png)
227231

SECURITY.md

+4-5
Original file line numberDiff line numberDiff line change
@@ -2,8 +2,8 @@
22

33
## Supported Versions
44

5-
Use this section to tell people about which versions of your project are
6-
currently being supported with security updates.
5+
Use this section to tell people about which versions of your project are currently being supported with
6+
security updates.
77

88
| Version | Supported |
99
| ------- | ------------------ |
@@ -16,6 +16,5 @@ currently being supported with security updates.
1616

1717
Use this section to tell people how to report a vulnerability.
1818

19-
Tell them where to go, how often they can expect to get an update on a
20-
reported vulnerability, what to expect if the vulnerability is accepted or
21-
declined, etc.
19+
Tell them where to go, how often they can expect to get an update on a reported vulnerability, what to expect
20+
if the vulnerability is accepted or declined, etc.

0 commit comments

Comments
 (0)