Skip to content

Commit

Permalink
Port & clean up v0.1.0 (#1)
Browse files Browse the repository at this point in the history
* Begin port

* Pilfer setup from UCAN

* Fix codeowner

* Same

* Housekeeping

* Mostly ported

* Requestor/Provider -> Sender/Receiver

* Extract links

* Cleanup wording

* Spelling & fix broken link

* Update dictionary

* Drop broken linter

* Update dict

* Update dictionary

* Get cute with diagrams

* Rearrange

* Session ID via peerid

* Typo

* Claridy what goes in the bloom
  • Loading branch information
expede committed Aug 18, 2023
1 parent b415dfc commit b5b0748
Show file tree
Hide file tree
Showing 16 changed files with 1,023 additions and 2 deletions.
5 changes: 5 additions & 0 deletions .clabot
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
{
"contributors": [
"expede"
]
}
5 changes: 5 additions & 0 deletions .github/CODEOWNERS
Validating CODEOWNERS rules …
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
# These owners will be the default owners for everything in
# the repo. Unless a later match takes precedence,
# @global-owner1 and @global-owner2 will be requested for
# review when someone opens a pull request.
* @expede @matheus23 @walkah
10 changes: 10 additions & 0 deletions .github/workflows/linkcheck.cfg.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
{
"ignorePatterns": [
{
"pattern": "https://share.ansi.org/Shared%20Documents/Standards%20Activities/American%20National%20Standards/Procedures,%20Guides,%20and%20Forms/2020_ANSI_Essential_Requirements.pdf"
},
{
"pattern": "https://share.ansi.org/Shared%20Documents/Standards%20Activities/American%20National%20Standards/Procedures,%20Guides,%20and%20Forms/2020_ANSI_Essential_Requirements.pdf"
}
]
}
19 changes: 19 additions & 0 deletions .github/workflows/linkcheck.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
name: Check Markdown links

on:
push:
branches:
- main
pull_request:

jobs:
markdown-link-check:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@master
- uses: gaurav-nelson/github-action-markdown-link-check@v1
with:
use-quiet-mode: "yes"
check-modified-files-only: "yes"
base-branch: "main"
config-file: "./.github/workflows/linkcheck.cfg.json"
17 changes: 17 additions & 0 deletions .github/workflows/spellcheck.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
name: "spellcheck"
on:
push:
branches:
- main
pull_request:

jobs:
spellcheck:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v3
- uses: matheus23/md-spellcheck-action@v4.2.2
with:
files-to-check: "README.md"
files-to-exclude: "LICENSE.md" # optional
words-to-ignore-file: ".github/workflows/words-to-ignore.txt"
147 changes: 147 additions & 0 deletions .github/workflows/words-to-ignore.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,147 @@
Acknowledgements
Agoric
Akiko
Akiko's
BCP
Bacalhau
Bitswap
CARv
CBOR
CDNs
CIDs
CRDT
Cap'N
CapTP
DAG-CBOR
DAG-JSON
DAGs
DHT
DNSLink
DSync
Dialable
ERTP
Enum
FPP
Filecoin
Golang
Gozalishvili
HTTP
HTTPS
Hardt
Holmgren
IPFS
IPLD
IPNS
IPVM
Invertible
Invoker's
Invokers
Irakli
JSON
JSONPath
JWT
JWT-encoded
Krüger
Kubo
Lakhani
Lemmer-Webber
Marsen
Merkle
OAuth
OCapN
OOM
PSU
Philipp
Pre-Draft
Proto
RESTful
RPC
SemVer
Spritely
TLS
TTL
UCAN
UCAN's
UCAN-IPLD
UCANTO
UCANs
URI
URIs
Vagg
Varsig
WSS
WebAssembly
WebNative
WebRTC
WebSockets
Worthington
XXH
Zeeshan
Zelenka
aRchive
atomicity
auth
backend
base64url
big-endian
canonicalized
counterintuitive
cryptographic
cryptographically
dataflow
de
deduplicate
deduplicated
deduplicates
deduplicating
deduplication
delegator
dholms
dialable
expede
facto
go-ipfs
impactful
implicits
interpretable
intra-cluster
invariants
invoker
iteratively
libp
memoization
multiformat
optimality
outmost
parallelize
pipelined
pipelining
pre-vacation
preorder
probabilistically
referentially
requestor's
responder
signalling
simple-but-evolvable
stateful
struct
subdelegated
subdelegation
subgraph
subgraphs
subquery
subtractive
subtype
th
tradeoff
trustless
ucanto
undialable
unicast
unlabelled
unpadded
unsynchronized
url
v0
validator
133 changes: 133 additions & 0 deletions CODE_OF_CONDUCT.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,133 @@
# Contributor Covenant Code of Conduct

## Our Pledge

We as members, contributors, and leaders pledge to make participation in our
community a harassment-free experience for everyone, regardless of age, body
size, visible or invisible disability, ethnicity, sex characteristics, gender
identity and expression, level of experience, education, socio-economic status,
nationality, personal appearance, race, caste, color, religion, or sexual
identity and orientation.

We pledge to act and interact in ways that contribute to an open, welcoming,
diverse, inclusive, and healthy community.

## Our Standards

Examples of behavior that contributes to a positive environment for our
community include:

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

Examples of unacceptable behavior include:

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

## Enforcement Responsibilities

Community leaders are responsible for clarifying and enforcing our standards of
acceptable behavior and will take appropriate and fair corrective action in
response to any behavior that they deem inappropriate, threatening, offensive,
or harmful.

Community leaders have the right and responsibility to remove, edit, or reject
comments, commits, code, wiki edits, issues, and other contributions that are
not aligned to this Code of Conduct, and will communicate reasons for moderation
decisions when appropriate.

## Scope

This Code of Conduct applies within all community spaces, and also applies when
an individual is officially representing the community in public spaces.
Examples of representing our community include using an official e-mail address,
posting via an official social media account, or acting as an appointed
representative at an online or offline event.

## Enforcement

Instances of abusive, harassing, or otherwise unacceptable behavior may be
reported to the community leaders responsible for enforcement at
hello@brooklynzelenka.com, philipp@fission.codes, or hello@fission.codes.
All complaints will be reviewed and investigated promptly and fairly.

All community leaders are obligated to respect the privacy and security of the
reporter of any incident.

## Enforcement Guidelines

Community leaders will follow these Community Impact Guidelines in determining
the consequences for any action they deem in violation of this Code of Conduct:

### 1. Correction

**Community Impact**: Use of inappropriate language or other behavior deemed
unprofessional or unwelcome in the community.

**Consequence**: A private, written warning from community leaders, providing
clarity around the nature of the violation and an explanation of why the
behavior was inappropriate. A public apology may be requested.

### 2. Warning

**Community Impact**: A violation through a single incident or series of
actions.

**Consequence**: A warning with consequences for continued behavior. No
interaction with the people involved, including unsolicited interaction with
those enforcing the Code of Conduct, for a specified period of time. This
includes avoiding interactions in community spaces as well as external channels
like social media. Violating these terms may lead to a temporary or permanent
ban.

### 3. Temporary Ban

**Community Impact**: A serious violation of community standards, including
sustained inappropriate behavior.

**Consequence**: A temporary ban from any sort of interaction or public
communication with the community for a specified period of time. No public or
private interaction with the people involved, including unsolicited interaction
with those enforcing the Code of Conduct, is allowed during this period.
Violating these terms may lead to a permanent ban.

### 4. Permanent Ban

**Community Impact**: Demonstrating a pattern of violation of community
standards, including sustained inappropriate behavior, harassment of an
individual, or aggression toward or disparagement of classes of individuals.

**Consequence**: A permanent ban from any sort of public interaction within the
community.

## Attribution

This Code of Conduct is adapted from the [Contributor Covenant][homepage],
version 2.1, available at
[https://www.contributor-covenant.org/version/2/1/code_of_conduct.html][v2.1].

Community Impact Guidelines were inspired by
[Mozilla's code of conduct enforcement ladder][Mozilla CoC].

For answers to common questions about this code of conduct, see the FAQ at
[https://www.contributor-covenant.org/faq][FAQ]. Translations are available at
[https://www.contributor-covenant.org/translations][translations].

[homepage]: https://www.contributor-covenant.org
[v2.1]: https://www.contributor-covenant.org/version/2/1/code_of_conduct.html
[Mozilla CoC]: https://github.com/mozilla/diversity
[FAQ]: https://www.contributor-covenant.org/faq
[translations]: https://www.contributor-covenant.org/translations

13 changes: 13 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
# Contributing

When contributing to this repository, please first discuss the change you wish to make via issue,
discussion, or any other method with the owners of this repository before making a change.

Please note we have a code of conduct, please follow it in all your interactions with the project.

## Pull Request Process

1. Ensure that you have signed the CLA: in a separate PR, add your information to
the [Notices](./Notices.md), and [CLA Bot](./.clabot).
2. Increase the version numbers in any examples files and the README.md to the new version that this
Pull Request would represent. The versioning scheme we use is [SemVer](http://semver.org/).
Loading

0 comments on commit b5b0748

Please sign in to comment.