Skip to content

Commit f3cb5e3

Browse files
Ma11hewThomasMa11hewThomas
authored
Spec plus restructure (#50)
* Restructure repository: reorganize spec, add tests, governance docs, and roadmap
1 parent 93ea827 commit f3cb5e3

File tree

220 files changed

+6534
-20029
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

220 files changed

+6534
-20029
lines changed

‎.github/workflows/release.yml‎

Lines changed: 74 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,74 @@
1+
name: Release
2+
3+
on:
4+
push:
5+
tags:
6+
- 'v*.*.*'
7+
8+
permissions:
9+
contents: write
10+
11+
jobs:
12+
test:
13+
name: Validate Schema
14+
runs-on: ubuntu-latest
15+
16+
steps:
17+
- name: Checkout repository
18+
uses: actions/checkout@v4
19+
20+
- name: Setup jsonschema
21+
uses: sourcemeta/jsonschema@v14.4.0
22+
23+
- name: Run conformance tests (normative)
24+
run: jsonschema test tests/normative --json > ctrf-normative.json
25+
26+
- name: Run informative tests
27+
run: jsonschema test tests/informative --json > ctrf-informative.json
28+
continue-on-error: true
29+
30+
- name: Validate example documents
31+
run: jsonschema validate schema/ctrf.schema.json examples/*.json
32+
33+
- name: Publish Conformance Test Results
34+
uses: ctrf-io/github-test-reporter@v1
35+
if: always()
36+
with:
37+
report-path: ctrf-normative.json
38+
github-report: true
39+
40+
- name: Publish Informative Test Results
41+
uses: ctrf-io/github-test-reporter@v1
42+
if: always()
43+
with:
44+
report-path: ctrf-informative.json
45+
github-report: true
46+
47+
release:
48+
name: Create Release
49+
runs-on: ubuntu-latest
50+
needs: test
51+
52+
steps:
53+
- name: Checkout repository
54+
uses: actions/checkout@v4
55+
56+
- name: Extract version from tag
57+
id: version
58+
run: echo "version=${GITHUB_REF#refs/tags/}" >> $GITHUB_OUTPUT
59+
60+
- name: Create GitHub Release
61+
uses: softprops/action-gh-release@v2
62+
with:
63+
name: CTRF ${{ steps.version.outputs.version }}
64+
draft: true
65+
make_latest: true
66+
generate_release_notes: true
67+
files: |
68+
schema/ctrf.schema.json
69+
spec/ctrf.md
70+
examples/*.json
71+
CHANGELOG.md
72+
LICENSE
73+
env:
74+
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

‎.github/workflows/test.yml‎

Lines changed: 50 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,50 @@
1+
name: Validate Schema
2+
3+
on:
4+
push:
5+
branches: ['**']
6+
7+
pull_request:
8+
branches: ['**']
9+
10+
jobs:
11+
test:
12+
name: Validate Schema
13+
runs-on: ubuntu-latest
14+
15+
steps:
16+
- name: Checkout repository
17+
uses: actions/checkout@v4
18+
19+
- name: Setup jsonschema
20+
uses: sourcemeta/jsonschema@v14.4.0
21+
22+
- name: Run format validation
23+
run: jsonschema fmt schema/ctrf.schema.json --check
24+
25+
- name: Run schema linting
26+
run: jsonschema lint schema/ctrf.schema.json --exclude top_level_examples
27+
28+
- name: Run conformance tests (normative)
29+
run: jsonschema test tests/normative --json > ctrf-normative.json
30+
31+
- name: Run informative tests
32+
run: jsonschema test tests/informative --json > ctrf-informative.json
33+
continue-on-error: true
34+
35+
- name: Validate example documents
36+
run: jsonschema validate schema/ctrf.schema.json examples/*.json
37+
38+
- name: Publish Conformance Test Results
39+
uses: ctrf-io/github-test-reporter@v1
40+
if: always()
41+
with:
42+
report-path: ctrf-normative.json
43+
github-report: true
44+
45+
- name: Publish Informative Test Results
46+
uses: ctrf-io/github-test-reporter@v1
47+
if: always()
48+
with:
49+
report-path: ctrf-informative.json
50+
github-report: true

‎.gitignore‎

Lines changed: 0 additions & 3 deletions
This file was deleted.

‎CHANGELOG.md‎

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
# Changelog
2+
3+
All notable changes to this project will be documented in this file.
4+
5+
The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/),
6+
and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
7+
8+
## [Unreleased]

‎CODE_OF_CONDUCT.md‎

Lines changed: 119 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,119 @@
1+
# Contributor Covenant Code of Conduct
2+
3+
## Our Pledge
4+
5+
We as members, contributors, and leaders pledge to make participation in our
6+
community a harassment-free experience for everyone, regardless of age, body
7+
size, visible or invisible disability, ethnicity, sex characteristics, gender
8+
identity and expression, level of experience, education, socio-economic status,
9+
nationality, personal appearance, race, religion, or sexual identity
10+
and orientation.
11+
12+
We pledge to act and interact in ways that contribute to an open, welcoming,
13+
diverse, inclusive, and healthy community.
14+
15+
## Our Standards
16+
17+
Examples of behavior that contributes to a positive environment for our
18+
community include:
19+
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,
24+
and learning from the experience
25+
* Focusing on what is best not just for us as individuals, but for the
26+
overall community
27+
28+
Examples of unacceptable behavior include:
29+
30+
* The use of sexualized language or imagery, and sexual attention or
31+
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
35+
address, without their explicit permission
36+
* Other conduct which could reasonably be considered inappropriate in a
37+
professional setting
38+
39+
## Enforcement Responsibilities
40+
41+
Community leaders are responsible for clarifying and enforcing our standards of
42+
acceptable behavior and will take appropriate and fair corrective action in
43+
response to any behavior that they deem inappropriate, threatening, offensive,
44+
or harmful.
45+
46+
Community leaders have the right and responsibility to remove, edit, or reject
47+
comments, commits, code, wiki edits, issues, and other contributions that are
48+
not aligned to this Code of Conduct, and will communicate reasons for moderation
49+
decisions when appropriate.
50+
51+
## Scope
52+
53+
This Code of Conduct applies within all community spaces, and also applies when
54+
an individual is officially representing the community in public spaces.
55+
Examples of representing our community include using an official e-mail address,
56+
posting via an official social media account, or acting as an appointed
57+
representative at an online or offline event.
58+
59+
## Enforcement
60+
61+
Instances of abusive, harassing, or otherwise unacceptable behavior may be
62+
reported to the community leaders responsible for enforcement at
63+
Matthew Poulton-White.
64+
All complaints will be reviewed and investigated promptly and fairly.
65+
66+
All community leaders are obligated to respect the privacy and security of the
67+
reporter of any incident.
68+
69+
## Enforcement Guidelines
70+
71+
Community leaders will follow these Community Impact Guidelines in determining
72+
the consequences for any action they deem in violation of this Code of Conduct:
73+
74+
### 1. Correction
75+
76+
**Community Impact**: Use of inappropriate language or other behavior deemed
77+
unprofessional or unwelcome in the community.
78+
79+
**Consequence**: A private, written warning from community leaders, providing
80+
clarity around the nature of the violation and an explanation of why the
81+
behavior was inappropriate. A public apology may be requested.
82+
83+
### 2. Warning
84+
85+
**Community Impact**: A violation through a single incident or series
86+
of actions.
87+
88+
**Consequence**: A warning with consequences for continued behavior. No
89+
interaction with the people involved, including unsolicited interaction with
90+
those enforcing the Code of Conduct, for a specified period of time. This
91+
includes avoiding interactions in community spaces as well as external channels
92+
like social media. Violating these terms may lead to a temporary or
93+
permanent ban.
94+
95+
### 3. Temporary Ban
96+
97+
**Community Impact**: A serious violation of community standards, including
98+
sustained inappropriate behavior.
99+
100+
**Consequence**: A temporary ban from any sort of interaction or public
101+
communication with the community for a specified period of time. No public or
102+
private interaction with the people involved, including unsolicited interaction
103+
with those enforcing the Code of Conduct, is allowed during this period.
104+
Violating these terms may lead to a permanent ban.
105+
106+
### 4. Permanent Ban
107+
108+
**Community Impact**: Demonstrating a pattern of violation of community
109+
standards, including sustained inappropriate behavior, harassment of an
110+
individual, or aggression toward or disparagement of classes of individuals.
111+
112+
**Consequence**: A permanent ban from any sort of public interaction within
113+
the community.
114+
115+
## Attribution
116+
117+
This Code of Conduct is adapted from the [Contributor Covenant][homepage],
118+
version 2.0, available at
119+
https://www.contributor-covenant.org/version/2/0/code_of_conduct.html.

0 commit comments

Comments
 (0)