Skip to content

Commit

Permalink
chore: fix markdown (#5)
Browse files Browse the repository at this point in the history
* chore: fix markdown

* chore: fix spelling

* Update project.dic

* chore: fix typos

* Create Earthfile

* Update Earthfile

* Update Earthfile

* Update Earthfile
  • Loading branch information
minikin authored Aug 23, 2024
1 parent 37e7cad commit 987aade
Show file tree
Hide file tree
Showing 6 changed files with 75 additions and 25 deletions.
11 changes: 11 additions & 0 deletions .config/dictionaries/project.dic
Original file line number Diff line number Diff line change
Expand Up @@ -3,10 +3,14 @@ abnf
ABNF
addrr
adminer
anypolicy
apskhem
Arissara
asyncio
Attributes
auditability
backpressure
bimap
bindgen
bkioshn
blockdiag
Expand All @@ -26,6 +30,7 @@ chaincode
CHAINCODE
chainsync
childs
Chotivichit
chrono
cids
ciphertext
Expand Down Expand Up @@ -114,6 +119,7 @@ maindbname
mapref
mdlint
mdns
minicbor
miniprotocol
miniprotocols
mithril
Expand All @@ -131,6 +137,7 @@ nextest
nolfs
notadb
nsec
OCSP
oneshot
openapi
openat
Expand All @@ -145,13 +152,15 @@ plpgsql
pollable
Pozhylenkov
pread
Precertificate
preopen
preopened
preopens
preprod
psql
pubk
pubkey
publickey
pubspec
pwrite
qpsg
Expand All @@ -163,6 +172,7 @@ REMOVEDIR
renameat
reqwest
retriggering
rlib
rulelist
rulename
RULENAME
Expand Down Expand Up @@ -208,6 +218,7 @@ unfinalized
unixfs
unlinkat
upnp
userid
utimensat
vitss
voteplan
Expand Down
34 changes: 17 additions & 17 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,23 +2,23 @@

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

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

All types of contributions are encouraged and valued.
Please make sure to read the relevant section before making your contribution.
Expand Down
12 changes: 6 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,20 +5,20 @@
Welcome to the Catalyst Libs mono repo, where we manage and maintain the interconnected Rust crates,
Dart and Flutter packages, and other libraries that make up the Catalyst project.

- [Catalyst Libs](#catalyst-libs)
- [Overview](#overview)
- [Getting Started](#getting-started)
- [Contributing](#contributing)
- [License](#license)
* [Catalyst Libs](#catalyst-libs)
* [Overview](#overview)
* [Getting Started](#getting-started)
* [Contributing](#contributing)
* [License](#license)

## Overview

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

## Getting Started
TODO

TODO

## Contributing

Expand Down
3 changes: 2 additions & 1 deletion cspell.json
Original file line number Diff line number Diff line change
Expand Up @@ -228,6 +228,7 @@
"*.excalidraw",
".vscode/**",
"**/.idea/**",
"**/.dart_tool/**"
"**/.dart_tool/**",
"./rust/cardano-chain-follower/examples/snapshot_data/**",
]
}
38 changes: 38 additions & 0 deletions rust/Earthfile
Original file line number Diff line number Diff line change
@@ -0,0 +1,38 @@
VERSION 0.8

IMPORT github.com/input-output-hk/catalyst-ci/earthly/rust:v3.1.24 AS rust-ci
# Use when debugging cat-ci locally.
# IMPORT ../../catalyst-ci/earthly/rust AS rust-ci

# builder : Set up our target toolchains, and copy our files.
builder:
DO rust-ci+SETUP
# COPY --dir .cargo .config crates bin .
# COPY Cargo.toml .
# COPY clippy.toml deny.toml rustfmt.toml .

## -----------------------------------------------------------------------------
##
## Standard CI targets.
##
## These targets are discovered and executed automatically by CI.

# check : Run check using the most efficient host tooling
# CI Automated Entry point.
check:
FROM +builder

DO rust-ci+EXECUTE --cmd="/scripts/std_checks.py"

# all-hosts-check : Test which runs check with all supported host tooling.
# Needs qemu or rosetta to run.
# Only used to validate tooling is working across host toolsets.
all-hosts-check:
BUILD --platform=linux/amd64 --platform=linux/arm64 +check

## -----------------------------------------------------------------------------

# local-ci-run: This step simulates the full CI run for local purposes only.
local-ci-run:
BUILD +check
BUILD +build
2 changes: 1 addition & 1 deletion rust/c509-certificate/src/c509_attributes/mod.rs
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@
//! SubjectDirectoryAttributes = [+Attributes]
//! ```
//!
//! For more information about `Atributes`,
//! For more information about `Attributes`,
//! visit [C509 Certificate](https://datatracker.ietf.org/doc/draft-ietf-cose-cbor-encoded-cert/09/)
use attribute::Attribute;
Expand Down

0 comments on commit 987aade

Please sign in to comment.