Skip to content

Commit f371d86

Browse files
DaveSkenderCopilotclaude
authored
ci: rename CI job to lint-and-test convention (#449)
Signed-off-by: Dave Skender <8432125+DaveSkender@users.noreply.github.com> Co-authored-by: copilot-swe-agent[bot] <198982749+Copilot@users.noreply.github.com> Co-authored-by: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
1 parent 98c6b92 commit f371d86

12 files changed

Lines changed: 48 additions & 70 deletions

File tree

.github/CODE_OF_CONDUCT.md

Lines changed: 13 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -17,23 +17,23 @@ diverse, inclusive, and healthy community.
1717
Examples of behavior that contributes to a positive environment for our
1818
community include:
1919

20-
* Demonstrating empathy and kindness toward other people
21-
* Being respectful of differing opinions, viewpoints, and experiences
22-
* Giving and gracefully accepting constructive feedback
23-
* Accepting responsibility and apologizing to those affected by our mistakes,
20+
- Demonstrating empathy and kindness toward other people
21+
- Being respectful of differing opinions, viewpoints, and experiences
22+
- Giving and gracefully accepting constructive feedback
23+
- Accepting responsibility and apologizing to those affected by our mistakes,
2424
and learning from the experience
25-
* Focusing on what is best not just for us as individuals, but for the
25+
- Focusing on what is best not just for us as individuals, but for the
2626
overall community
2727

2828
Examples of unacceptable behavior include:
2929

30-
* The use of sexualized language or imagery, and sexual attention or
30+
- The use of sexualized language or imagery, and sexual attention or
3131
advances of any kind
32-
* Trolling, insulting or derogatory comments, and personal or political attacks
33-
* Public or private harassment
34-
* Publishing others' private information, such as a physical or email
32+
- Trolling, insulting or derogatory comments, and personal or political attacks
33+
- Public or private harassment
34+
- Publishing others' private information, such as a physical or email
3535
address, without their explicit permission
36-
* Other conduct which could reasonably be considered inappropriate in a
36+
- Other conduct which could reasonably be considered inappropriate in a
3737
professional setting
3838

3939
## Enforcement Responsibilities
@@ -116,13 +116,13 @@ the community.
116116

117117
This Code of Conduct is adapted from the [Contributor Covenant][homepage],
118118
version 2.0, available at
119-
https://www.contributor-covenant.org/version/2/0/code_of_conduct.html.
119+
<https://www.contributor-covenant.org/version/2/0/code_of_conduct.html>.
120120

121121
Community Impact Guidelines were inspired by [Mozilla's code of conduct
122122
enforcement ladder](https://github.com/mozilla/diversity).
123123

124124
[homepage]: https://www.contributor-covenant.org
125125

126126
For answers to common questions about this code of conduct, see the FAQ at
127-
https://www.contributor-covenant.org/faq. Translations are available at
128-
https://www.contributor-covenant.org/translations.
127+
<https://www.contributor-covenant.org/faq>. Translations are available at
128+
<https://www.contributor-covenant.org/translations>.

.github/workflows/ci.yml

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,13 +8,16 @@ permissions:
88
contents: read
99

1010
jobs:
11-
linting:
11+
lint-and-test:
1212
runs-on: ubuntu-latest
1313

1414
steps:
1515
- name: Checkout source
1616
uses: actions/checkout@v6
1717

18+
- name: Lint markdown
19+
uses: DavidAnson/markdownlint-cli2-action@v23
20+
1821
- name: Setup .NET
1922
uses: actions/setup-dotnet@v5
2023
with:

.markdownlint-cli2.jsonc

Lines changed: 16 additions & 50 deletions
Original file line numberDiff line numberDiff line change
@@ -1,57 +1,23 @@
11
{
2-
"globs": [
3-
"**/*.md",
4-
"**/*.markdown"
5-
],
6-
"ignores": [
7-
"**/.pytest_cache/**",
8-
"**/.coverage/**",
9-
"**/.git/**",
10-
"**/.github/**",
11-
"**/.venv/**",
12-
"**/_site/**",
13-
"**/__pycache__/**",
14-
"**/_cslib/**",
15-
"**/node_modules/**",
16-
"**/TestResults/**",
17-
"**/*playwright*/**",
18-
"**/vendor/**"
19-
],
2+
"globs": ["**/*.md"],
3+
"gitignore": true,
4+
"ignores": ["node_modules/**"],
205
"config": {
216
"default": true,
22-
"MD003": {
23-
"style": "atx"
24-
},
25-
"MD004": {
26-
"style": "dash"
27-
},
28-
"MD007": {
29-
"indent": 2
30-
},
31-
"MD013": false,
32-
"MD025": false,
33-
"MD029": {
34-
"style": "ordered"
35-
},
7+
"MD003": { "style": "atx" },
8+
"MD004": { "style": "dash" },
9+
"MD007": { "indent": 2 },
10+
"MD013": false, // allow long lines
11+
"MD024": { "siblings_only": true },
12+
"MD025": false, // Jekyll docs intentionally use multiple/templated h1 headings
13+
"MD028": false, // allow separation between quote blocks
3614
"MD033": {
37-
"allowed_elements": [
38-
"a",
39-
"code",
40-
"details",
41-
"summary",
42-
"sub",
43-
"sup",
44-
"kbd",
45-
"abbr",
46-
"img",
47-
"br"
48-
]
49-
},
50-
"MD046": {
51-
"style": "fenced"
15+
"allowed_elements": ["details", "summary", "br", "sub", "sup", "kbd", "abbr", "a", "img", "span", "code"]
5216
},
53-
"MD048": {
54-
"style": "backtick"
55-
}
17+
"MD041": false,
18+
"MD046": { "style": "fenced" },
19+
"MD048": { "style": "backtick" },
20+
"MD055": false, // docs use leading-pipe aligned tables; pipe style not enforced
21+
"MD060": false // table column style not enforced
5622
}
5723
}

docs/Gemfile.lock

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -40,7 +40,7 @@ GEM
4040
ffi (>= 1.15.0)
4141
eventmachine (1.2.7)
4242
execjs (2.10.0)
43-
faraday (2.14.1)
43+
faraday (2.14.2)
4444
faraday-net_http (>= 2.0, < 3.5)
4545
json
4646
logger

docs/_indicators/Atr.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ layout: indicator
99

1010
><span class="indicator-syntax">**get_atr**(*quotes, lookback_periods=14*)</span>
1111
12-
### Related interfaces
12+
## Related interfaces
1313

1414
For raw True Range (TR) only, use:
1515
>**get_tr**(quotes) -> TrResults[TrResult]

docs/_indicators/Ema.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -11,11 +11,13 @@ layout: indicator
1111
1212
## Parameters
1313

14+
<!-- markdownlint-disable MD051 -- #candlepart-options resolves via Jekyll {% include candlepart-options.md %} below -->
1415
| name | type | notes
1516
| -- |-- |--
1617
| `quotes` | Iterable[Quote] | Iterable of the [Quote class]({{site.baseurl}}/guide/#historical-quotes) or [its sub-class]({{site.baseurl}}/guide/#using-custom-quote-classes). <br><span class='qna-dataframe'> • [See here]({{site.baseurl}}/guide/#using-pandasdataframe) for usage with pandas.DataFrame</span>
1718
| `lookback_periods` | int | Number of periods (`N`) in the moving average. Must be greater than 0.
1819
| `candle_part` | CandlePart, *default CandlePart.CLOSE* | Specify candle part to evaluate. See [CandlePart options](#candlepart-options) below.
20+
<!-- markdownlint-enable MD051 -->
1921

2022
### Historical quotes requirements
2123

docs/_indicators/Fractal.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ layout: indicator
99

1010
><span class="indicator-syntax">**get_fractal**(*quotes, window_span=2, end_type = EndType.HIGH_LOW*)</span>
1111
12-
### More overloaded interfaces
12+
## More overloaded interfaces
1313

1414
**get_fractal**(quotes, left_span, right_span, end_type)
1515

docs/_indicators/Ichimoku.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ layout: indicator
1010

1111
><span class="indicator-syntax">**get_ichimoku**(*quotes, tenkan_periods=9, kijun_periods=26, senkou_b_periods=52*)</span>
1212
13-
### More overloaded interfaces
13+
## More overloaded interfaces
1414

1515
**get_ichimoku**(quotes, tenkan_periods, kijun_periods, senkou_b_periods,
1616
offset_periods)

docs/_indicators/Macd.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -11,13 +11,15 @@ layout: indicator
1111
1212
## Parameters
1313

14+
<!-- markdownlint-disable MD051 -- #candlepart-options resolves via Jekyll {% include candlepart-options.md %} below -->
1415
| name | type | notes
1516
| -- |-- |--
1617
| `quotes` | Iterable[Quote] | Iterable of the [Quote class]({{site.baseurl}}/guide/#historical-quotes) or [its sub-class]({{site.baseurl}}/guide/#using-custom-quote-classes). <br><span class='qna-dataframe'> • [See here]({{site.baseurl}}/guide/#using-pandasdataframe) for usage with pandas.DataFrame</span>
1718
| `fast_periods` | int, *default 12* | Number of periods (`F`) for the faster moving average. Must be greater than 0.
1819
| `slow_periods` | int, *default 26* | Number of periods (`S`) for the slower moving average. Must be greater than `fast_periods`.
1920
| `signal_periods` | int, *default 9* | Number of periods (`P`) for the moving average of MACD. Must be greater than or equal to 0.
2021
| `candle_part` | CandlePart, *default CandlePart.CLOSE* | Specify candle part to evaluate. See [CandlePart options](#candlepart-options) below.
22+
<!-- markdownlint-enable MD051 -->
2123

2224
### Historical quotes requirements
2325

docs/_indicators/ParabolicSar.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ layout: indicator
99

1010
><span class="indicator-syntax">**get_parabolic_sar**(*quotes, acceleration_step=0.02, max_acceleration_factor=0.2*)</span>
1111
12-
### More overloaded interfaces
12+
## More overloaded interfaces
1313

1414
**get_parabolic_sar**(quotes, acceleration_step, max_acceleration_factor, initial_factor)
1515

0 commit comments

Comments
 (0)