Skip to content

Commit 35e96e9

Browse files
author
KoyoAli
committed
Okwu African Language Parallel Corpus: tooling, schema, and validation
0 parents  commit 35e96e9

33 files changed

Lines changed: 1272 additions & 0 deletions

.github/ISSUE_TEMPLATE/config.yml

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
blank_issues_enabled: true
2+
contact_links:
3+
- name: Report a security or rights problem
4+
url: https://github.com/Okwu-AI/corpus/security/advisories/new
5+
about: Do not open a public issue for vulnerabilities or rights disputes. See SECURITY.md.
Lines changed: 48 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,48 @@
1+
name: Suggest a correction
2+
description: Report a translation, spelling, diacritic or tone error in a record
3+
labels: [correction, needs-review]
4+
body:
5+
- type: input
6+
id: record_id
7+
attributes:
8+
label: Record ID
9+
placeholder: e.g. YO-000123
10+
validations:
11+
required: true
12+
- type: input
13+
id: current
14+
attributes:
15+
label: Current text
16+
description: Copy it exactly as it appears
17+
validations:
18+
required: true
19+
- type: input
20+
id: proposed
21+
attributes:
22+
label: Proposed text
23+
description: Include all diacritics and tone marks
24+
validations:
25+
required: true
26+
- type: textarea
27+
id: reason
28+
attributes:
29+
label: Why is the current text wrong?
30+
validations:
31+
required: true
32+
- type: dropdown
33+
id: basis
34+
attributes:
35+
label: Basis for the correction
36+
options:
37+
- I am a native or fluent speaker
38+
- Published reference (give it below)
39+
- Other
40+
validations:
41+
required: true
42+
- type: checkboxes
43+
id: rights
44+
attributes:
45+
label: Rights
46+
options:
47+
- label: I have the right to contribute this text, and agree it may be published under the project licence.
48+
required: true

.github/pull_request_template.md

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
## What this changes
2+
3+
## Checklist
4+
- [ ] Automated checks pass
5+
- [ ] Schema unchanged, or `schema/public-record.schema.json` updated and version bumped
6+
- [ ] Source and rights of any new content are recorded
7+
- [ ] Documentation updated if behaviour changed
8+
9+
## Reviewer notes

.github/workflows/checks.yml

Lines changed: 36 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,36 @@
1+
name: checks
2+
on: [push, pull_request]
3+
4+
jobs:
5+
hygiene:
6+
name: repo hygiene
7+
runs-on: ubuntu-latest
8+
steps:
9+
- uses: actions/checkout@v4
10+
- name: Required files present
11+
run: |
12+
for f in LICENSE README.md CONTRIBUTING.md CODE_OF_CONDUCT.md GOVERNANCE.md SECURITY.md; do
13+
[ -f "$f" ] || { echo "::error::missing $f"; exit 1; }
14+
done
15+
16+
schema:
17+
name: records validate against schema
18+
runs-on: ubuntu-latest
19+
steps:
20+
- uses: actions/checkout@v4
21+
- run: pip install jsonschema
22+
- run: python validation/check_schema.py
23+
24+
normalisation:
25+
name: unicode form is consistent
26+
runs-on: ubuntu-latest
27+
steps:
28+
- uses: actions/checkout@v4
29+
- run: python validation/check_normalisation.py
30+
31+
duplicates:
32+
name: no duplicate pairs
33+
runs-on: ubuntu-latest
34+
steps:
35+
- uses: actions/checkout@v4
36+
- run: python validation/check_duplicates.py

.github/workflows/scorecard.yml

Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
1+
name: Scorecard supply-chain security
2+
on:
3+
branch_protection_rule:
4+
schedule:
5+
- cron: '27 3 * * 1'
6+
permissions: read-all
7+
jobs:
8+
analysis:
9+
name: Scorecard analysis
10+
runs-on: ubuntu-latest
11+
permissions:
12+
security-events: write
13+
id-token: write
14+
steps:
15+
- uses: actions/checkout@v4
16+
with: { persist-credentials: false }
17+
- uses: ossf/scorecard-action@v2.4.0
18+
with:
19+
results_file: results.sarif
20+
results_format: sarif
21+
publish_results: true
22+
- uses: github/codeql-action/upload-sarif@v3
23+
with: { sarif_file: results.sarif }

CHANGELOG.md

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
# Changelog
2+
3+
Every released version: what changed, what was corrected, what was withdrawn.
4+
5+
## [Unreleased]
6+
7+
## [1.0.0] - 2026-08-31
8+
- Initial public release.

CITATION.cff

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
cff-version: 1.2.0
2+
message: "If you use this corpus, please cite it."
3+
title: "African Language Parallel Corpus"
4+
type: dataset
5+
authors:
6+
- name: "Okwu"
7+
website: "https://okwu.ai"
8+
version: "1.0.0"
9+
date-released: "2026-08-31"
10+
license: CDLA-Permissive-2.0
11+
repository-code: "https://github.com/Okwu-AI/corpus"
12+
url: "https://huggingface.co/datasets/Okwu/african-language-parallel-corpus"

CODEOWNERS

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
* @Okwu-AI/maintainers
2+
/schema/ @Okwu-AI/maintainers
3+
/release/ @Okwu-AI/maintainers
4+
/SECURITY.md @Okwu-AI/maintainers
5+
/docs/validation-guide.md @Okwu-AI/language-leads

CODE_OF_CONDUCT.md

Lines changed: 89 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,89 @@
1+
+++
2+
version = "2.1"
3+
aliases = ["/version/2/1"]
4+
reportingPlaceholder = "conduct@okwu.ai"
5+
+++
6+
7+
# Contributor Covenant Code of Conduct
8+
9+
## Our Pledge
10+
11+
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.
12+
13+
We pledge to act and interact in ways that contribute to an open, welcoming, diverse, inclusive, and healthy community.
14+
15+
## Our Standards
16+
17+
Examples of behavior that contributes to a positive environment for our community include:
18+
19+
* Demonstrating empathy and kindness toward other people
20+
* Being respectful of differing opinions, viewpoints, and experiences
21+
* Giving and gracefully accepting constructive feedback
22+
* Accepting responsibility and apologizing to those affected by our mistakes, and learning from the experience
23+
* Focusing on what is best not just for us as individuals, but for the overall community
24+
25+
Examples of unacceptable behavior include:
26+
27+
* The use of sexualized language or imagery, and sexual attention or advances of any kind
28+
* Trolling, insulting or derogatory comments, and personal or political attacks
29+
* Public or private harassment
30+
* Publishing others' private information, such as a physical or email address, without their explicit permission
31+
* Other conduct which could reasonably be considered inappropriate in a professional setting
32+
33+
## Enforcement Responsibilities
34+
35+
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.
36+
37+
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.
38+
39+
## Scope
40+
41+
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.
42+
43+
## Enforcement
44+
45+
Instances of abusive, harassing, or otherwise unacceptable behavior may be reported to the community leaders responsible for enforcement at conduct@okwu.ai. All complaints will be reviewed and investigated promptly and fairly.
46+
47+
All community leaders are obligated to respect the privacy and security of the reporter of any incident.
48+
49+
## Enforcement Guidelines
50+
51+
Community leaders will follow these Community Impact Guidelines in determining the consequences for any action they deem in violation of this Code of Conduct:
52+
53+
### 1. Correction
54+
55+
**Community Impact**: Use of inappropriate language or other behavior deemed unprofessional or unwelcome in the community.
56+
57+
**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.
58+
59+
### 2. Warning
60+
61+
**Community Impact**: A violation through a single incident or series of actions.
62+
63+
**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.
64+
65+
### 3. Temporary Ban
66+
67+
**Community Impact**: A serious violation of community standards, including sustained inappropriate behavior.
68+
69+
**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.
70+
71+
### 4. Permanent Ban
72+
73+
**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.
74+
75+
**Consequence**: A permanent ban from any sort of public interaction within the community.
76+
77+
## Attribution
78+
79+
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].
80+
81+
Community Impact Guidelines were inspired by [Mozilla's code of conduct enforcement ladder][Mozilla CoC].
82+
83+
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].
84+
85+
[homepage]: https://www.contributor-covenant.org
86+
[v2.1]: https://www.contributor-covenant.org/version/2/1/code_of_conduct.html
87+
[Mozilla CoC]: https://github.com/mozilla/diversity
88+
[FAQ]: https://www.contributor-covenant.org/faq
89+
[translations]: https://www.contributor-covenant.org/translations

CONTRIBUTING.md

Lines changed: 28 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,28 @@
1+
# Contributing
2+
3+
Four kinds of contribution: **corrections**, **metadata improvements**, **documentation**, and
4+
**new records**. Corrections are the easiest place to start.
5+
6+
## Correcting a record
7+
1. Find the record and note its `record_id`.
8+
2. Open an issue using the *Correction* template.
9+
3. Give the current text, your proposed text, and why it is wrong.
10+
4. A validator for that language reviews it. Expect a first response within
11+
5 working days.
12+
13+
## Contributing new records
14+
New records need more than the text. You must tell us **where it came from** and
15+
**that you have the right to contribute it**. Contributions without that cannot be
16+
accepted, however good the translation.
17+
18+
## Review
19+
Every contribution runs through automated checks, then human review by a qualified
20+
speaker of that language. Reviewers work from a published rubric — see
21+
`docs/validation-guide.md`. Decisions and reasons are recorded publicly.
22+
23+
Disagreements between reviewers are escalated and adjudicated rather than averaged.
24+
25+
## Becoming a reviewer
26+
Contributors with a track record of accepted contributions can apply.
27+
See `GOVERNANCE.md`.
28+

0 commit comments

Comments
 (0)