Skip to content

Commit 987aade

Browse files
authored
chore: fix markdown (#5)
* chore: fix markdown * chore: fix spelling * Update project.dic * chore: fix typos * Create Earthfile * Update Earthfile * Update Earthfile * Update Earthfile
1 parent 37e7cad commit 987aade

File tree

6 files changed

+75
-25
lines changed

6 files changed

+75
-25
lines changed

.config/dictionaries/project.dic

+11
Original file line numberDiff line numberDiff line change
@@ -3,10 +3,14 @@ abnf
33
ABNF
44
addrr
55
adminer
6+
anypolicy
67
apskhem
8+
Arissara
79
asyncio
10+
Attributes
811
auditability
912
backpressure
13+
bimap
1014
bindgen
1115
bkioshn
1216
blockdiag
@@ -26,6 +30,7 @@ chaincode
2630
CHAINCODE
2731
chainsync
2832
childs
33+
Chotivichit
2934
chrono
3035
cids
3136
ciphertext
@@ -114,6 +119,7 @@ maindbname
114119
mapref
115120
mdlint
116121
mdns
122+
minicbor
117123
miniprotocol
118124
miniprotocols
119125
mithril
@@ -131,6 +137,7 @@ nextest
131137
nolfs
132138
notadb
133139
nsec
140+
OCSP
134141
oneshot
135142
openapi
136143
openat
@@ -145,13 +152,15 @@ plpgsql
145152
pollable
146153
Pozhylenkov
147154
pread
155+
Precertificate
148156
preopen
149157
preopened
150158
preopens
151159
preprod
152160
psql
153161
pubk
154162
pubkey
163+
publickey
155164
pubspec
156165
pwrite
157166
qpsg
@@ -163,6 +172,7 @@ REMOVEDIR
163172
renameat
164173
reqwest
165174
retriggering
175+
rlib
166176
rulelist
167177
rulename
168178
RULENAME
@@ -208,6 +218,7 @@ unfinalized
208218
unixfs
209219
unlinkat
210220
upnp
221+
userid
211222
utimensat
212223
vitss
213224
voteplan

CONTRIBUTING.md

+17-17
Original file line numberDiff line numberDiff line change
@@ -2,23 +2,23 @@
22

33
First off, thanks for taking the time to contribute! ❤️
44

5-
- [Contributing to Catalyst Libs](#contributing-to-catalyst-libs)
6-
- [Code of Conduct](#code-of-conduct)
7-
- [I Have a Question](#i-have-a-question)
8-
- [I Want To Contribute](#i-want-to-contribute)
9-
- [Reporting Bugs](#reporting-bugs)
10-
- [Before Submitting a Bug Report](#before-submitting-a-bug-report)
11-
- [How Do I Submit a Good Bug Report?](#how-do-i-submit-a-good-bug-report)
12-
- [Suggesting Enhancements](#suggesting-enhancements)
13-
- [Before Submitting an Enhancement](#before-submitting-an-enhancement)
14-
- [How Do I Submit a Good Enhancement Suggestion?](#how-do-i-submit-a-good-enhancement-suggestion)
15-
- [Your First Code Contribution](#your-first-code-contribution)
16-
- [Improving The Documentation](#improving-the-documentation)
17-
- [Style guides](#style-guides)
18-
- [Rust](#rust)
19-
- [Dart](#dart)
20-
- [Flutter](#flutter)
21-
- [Commit Messages](#commit-messages)
5+
* [Contributing to Catalyst Libs](#contributing-to-catalyst-libs)
6+
* [Code of Conduct](#code-of-conduct)
7+
* [I Have a Question](#i-have-a-question)
8+
* [I Want To Contribute](#i-want-to-contribute)
9+
* [Reporting Bugs](#reporting-bugs)
10+
* [Before Submitting a Bug Report](#before-submitting-a-bug-report)
11+
* [How Do I Submit a Good Bug Report?](#how-do-i-submit-a-good-bug-report)
12+
* [Suggesting Enhancements](#suggesting-enhancements)
13+
* [Before Submitting an Enhancement](#before-submitting-an-enhancement)
14+
* [How Do I Submit a Good Enhancement Suggestion?](#how-do-i-submit-a-good-enhancement-suggestion)
15+
* [Your First Code Contribution](#your-first-code-contribution)
16+
* [Improving The Documentation](#improving-the-documentation)
17+
* [Style guides](#style-guides)
18+
* [Rust](#rust)
19+
* [Dart](#dart)
20+
* [Flutter](#flutter)
21+
* [Commit Messages](#commit-messages)
2222

2323
All types of contributions are encouraged and valued.
2424
Please make sure to read the relevant section before making your contribution.

README.md

+6-6
Original file line numberDiff line numberDiff line change
@@ -5,20 +5,20 @@
55
Welcome to the Catalyst Libs mono repo, where we manage and maintain the interconnected Rust crates,
66
Dart and Flutter packages, and other libraries that make up the Catalyst project.
77

8-
- [Catalyst Libs](#catalyst-libs)
9-
- [Overview](#overview)
10-
- [Getting Started](#getting-started)
11-
- [Contributing](#contributing)
12-
- [License](#license)
8+
* [Catalyst Libs](#catalyst-libs)
9+
* [Overview](#overview)
10+
* [Getting Started](#getting-started)
11+
* [Contributing](#contributing)
12+
* [License](#license)
1313

1414
## Overview
1515

1616
This monorepo serves as a unified codebase for the Catalyst project.
1717
Using a monorepo simplifies our dependency management, streamlines testing, and fosters code sharing.
1818

1919
## Getting Started
20-
TODO
2120

21+
TODO
2222

2323
## Contributing
2424

cspell.json

+2-1
Original file line numberDiff line numberDiff line change
@@ -228,6 +228,7 @@
228228
"*.excalidraw",
229229
".vscode/**",
230230
"**/.idea/**",
231-
"**/.dart_tool/**"
231+
"**/.dart_tool/**",
232+
"./rust/cardano-chain-follower/examples/snapshot_data/**",
232233
]
233234
}

rust/Earthfile

+38
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,38 @@
1+
VERSION 0.8
2+
3+
IMPORT github.com/input-output-hk/catalyst-ci/earthly/rust:v3.1.24 AS rust-ci
4+
# Use when debugging cat-ci locally.
5+
# IMPORT ../../catalyst-ci/earthly/rust AS rust-ci
6+
7+
# builder : Set up our target toolchains, and copy our files.
8+
builder:
9+
DO rust-ci+SETUP
10+
# COPY --dir .cargo .config crates bin .
11+
# COPY Cargo.toml .
12+
# COPY clippy.toml deny.toml rustfmt.toml .
13+
14+
## -----------------------------------------------------------------------------
15+
##
16+
## Standard CI targets.
17+
##
18+
## These targets are discovered and executed automatically by CI.
19+
20+
# check : Run check using the most efficient host tooling
21+
# CI Automated Entry point.
22+
check:
23+
FROM +builder
24+
25+
DO rust-ci+EXECUTE --cmd="/scripts/std_checks.py"
26+
27+
# all-hosts-check : Test which runs check with all supported host tooling.
28+
# Needs qemu or rosetta to run.
29+
# Only used to validate tooling is working across host toolsets.
30+
all-hosts-check:
31+
BUILD --platform=linux/amd64 --platform=linux/arm64 +check
32+
33+
## -----------------------------------------------------------------------------
34+
35+
# local-ci-run: This step simulates the full CI run for local purposes only.
36+
local-ci-run:
37+
BUILD +check
38+
BUILD +build

rust/c509-certificate/src/c509_attributes/mod.rs

+1-1
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@
1010
//! SubjectDirectoryAttributes = [+Attributes]
1111
//! ```
1212
//!
13-
//! For more information about `Atributes`,
13+
//! For more information about `Attributes`,
1414
//! visit [C509 Certificate](https://datatracker.ietf.org/doc/draft-ietf-cose-cbor-encoded-cert/09/)
1515
1616
use attribute::Attribute;

0 commit comments

Comments
 (0)