Skip to content

Commit 6edc0a9

Browse files
hartemyaakoubhartemyaakoub
committed
chore: add OSS files + CI
- LICENSE: AGPL-3.0-or-later - SECURITY.md, CODE_OF_CONDUCT.md (Contributor Covenant 2.1) - CONTRIBUTING.md: translation guidelines + content standards - README.md: rewritten with hero, content + stack overview - .github/FUNDING.yml, CODEOWNERS, PR + issue templates - .github/dependabot.yml: weekly npm + actions updates (Astro grouped) - .github/workflows/ci.yml: astro check + build + verify key pages
1 parent 2bacf82 commit 6edc0a9

14 files changed

Lines changed: 1154 additions & 32 deletions

File tree

‎.github/CODEOWNERS‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
1+
# Every change requires a review from a TKAWEN maintainer.
2+
* @hartemyaakoub

‎.github/FUNDING.yml‎

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
# GitHub Sponsors will appear here once approved.
2+
github: [hartemyaakoub]
3+
custom: ["https://tkawen.com", "mailto:DIRECTION@takawen.dz"]

‎.github/ISSUE_TEMPLATE/bug.yml‎

Lines changed: 64 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,64 @@
1+
name: Bug report
2+
description: Something is broken — report it here.
3+
title: "[bug] "
4+
labels: ["bug", "triage"]
5+
body:
6+
- type: markdown
7+
attributes:
8+
value: |
9+
Thanks for taking the time to report a bug. The clearer your report, the faster we can fix it.
10+
11+
- type: textarea
12+
id: what-happened
13+
attributes:
14+
label: What happened?
15+
description: A clear and concise description of the bug.
16+
placeholder: When I do X, Y happens instead of Z.
17+
validations:
18+
required: true
19+
20+
- type: textarea
21+
id: reproduce
22+
attributes:
23+
label: Steps to reproduce
24+
description: Minimal sequence that triggers the bug.
25+
placeholder: |
26+
1. Run `cargo run`
27+
2. Open http://localhost:8088/
28+
3. ...
29+
validations:
30+
required: true
31+
32+
- type: textarea
33+
id: expected
34+
attributes:
35+
label: Expected behaviour
36+
validations:
37+
required: true
38+
39+
- type: input
40+
id: version
41+
attributes:
42+
label: Version / commit
43+
description: Output of `git rev-parse --short HEAD` or a release tag
44+
placeholder: "v0.1.0 or c9d48c4"
45+
validations:
46+
required: true
47+
48+
- type: dropdown
49+
id: os
50+
attributes:
51+
label: Operating system
52+
options:
53+
- Linux
54+
- macOS
55+
- Windows
56+
- Other
57+
validations:
58+
required: true
59+
60+
- type: textarea
61+
id: logs
62+
attributes:
63+
label: Relevant logs / output
64+
render: shell

‎.github/ISSUE_TEMPLATE/config.yml‎

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
blank_issues_enabled: false
2+
contact_links:
3+
- name: Question or discussion
4+
url: https://github.com/tkawen/tkawen-developer-docs/discussions
5+
about: Use Discussions for questions, ideas, and show-and-tell.
6+
- name: Security vulnerability
7+
url: https://github.com/tkawen/tkawen-developer-docs/security/advisories/new
8+
about: Report security issues privately — do NOT open a public issue.
9+
- name: Developer documentation
10+
url: https://developer.tkawen.com
11+
about: Read the official docs before filing an issue.
12+
- name: Community Discord
13+
url: https://discord.gg/tkawen
14+
about: Real-time chat with the team and other developers.

‎.github/ISSUE_TEMPLATE/feature.yml‎

Lines changed: 35 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,35 @@
1+
name: Feature request
2+
description: Suggest an improvement or a new feature.
3+
title: "[feature] "
4+
labels: ["enhancement", "triage"]
5+
body:
6+
- type: textarea
7+
id: problem
8+
attributes:
9+
label: What problem are you trying to solve?
10+
description: Describe the use-case in your own words. Avoid prescribing a solution here.
11+
validations:
12+
required: true
13+
14+
- type: textarea
15+
id: solution
16+
attributes:
17+
label: Proposed solution (optional)
18+
description: If you have one in mind.
19+
20+
- type: textarea
21+
id: alternatives
22+
attributes:
23+
label: Alternatives considered
24+
description: Other approaches you have looked at.
25+
26+
- type: dropdown
27+
id: priority
28+
attributes:
29+
label: How critical is this for your work?
30+
options:
31+
- Blocker — I cannot use TKAWEN without it
32+
- Important — significant workaround required
33+
- Nice to have — would improve my workflow
34+
validations:
35+
required: true

‎.github/ISSUE_TEMPLATE/question.yml‎

Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
1+
name: Question
2+
description: Have a question? Try Discussions first.
3+
title: "[question] "
4+
labels: ["question"]
5+
body:
6+
- type: markdown
7+
attributes:
8+
value: |
9+
**Please use [Discussions](https://github.com/tkawen/tkawen-com/discussions) for questions when possible.**
10+
Use this issue type only if you believe the question reveals a documentation gap or bug.
11+
12+
- type: textarea
13+
id: question
14+
attributes:
15+
label: Question
16+
validations:
17+
required: true
18+
19+
- type: textarea
20+
id: tried
21+
attributes:
22+
label: What you have tried so far
23+
description: Links to docs, SDK calls attempted, etc.

‎.github/PULL_REQUEST_TEMPLATE.md‎

Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,25 @@
1+
## What this PR does
2+
3+
<!-- One sentence: what changed and why. -->
4+
5+
## Type of change
6+
7+
- [ ] Bug fix (non-breaking change which fixes an issue)
8+
- [ ] New feature (non-breaking change which adds functionality)
9+
- [ ] Breaking change (fix or feature that would cause existing functionality to not work as expected)
10+
- [ ] Documentation only
11+
- [ ] Refactor (no functional change)
12+
- [ ] Performance improvement
13+
- [ ] Build / CI / tooling
14+
15+
## Checklist
16+
17+
- [ ] My code follows the style of this project (`./vendor/bin/pint` / `cargo fmt` / `prettier` as applicable)
18+
- [ ] I have added tests where appropriate
19+
- [ ] All new and existing tests pass locally
20+
- [ ] I have updated documentation where appropriate
21+
- [ ] My changes generate no new warnings
22+
23+
## Related issues
24+
25+
<!-- Closes #123 -->

‎.github/dependabot.yml‎

Lines changed: 28 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,28 @@
1+
version: 2
2+
updates:
3+
- package-ecosystem: npm
4+
directory: /
5+
schedule:
6+
interval: weekly
7+
day: monday
8+
open-pull-requests-limit: 10
9+
labels:
10+
- dependencies
11+
- javascript
12+
versioning-strategy: increase
13+
groups:
14+
astro:
15+
patterns:
16+
- "astro"
17+
- "@astrojs/*"
18+
starlight:
19+
patterns:
20+
- "@astrojs/starlight"
21+
22+
- package-ecosystem: github-actions
23+
directory: /
24+
schedule:
25+
interval: weekly
26+
labels:
27+
- dependencies
28+
- ci

‎.github/workflows/ci.yml‎

Lines changed: 38 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,38 @@
1+
name: ci
2+
3+
on:
4+
push:
5+
branches: [main]
6+
pull_request:
7+
branches: [main]
8+
9+
jobs:
10+
build:
11+
name: astro build + link check
12+
runs-on: ubuntu-latest
13+
steps:
14+
- uses: actions/checkout@v4
15+
16+
- name: Setup Node.js
17+
uses: actions/setup-node@v4
18+
with:
19+
node-version: 22
20+
cache: npm
21+
22+
- name: Install dependencies
23+
run: npm ci
24+
25+
- name: Astro check
26+
run: npm run astro -- check
27+
28+
- name: Build static site
29+
run: npm run build
30+
31+
- name: Verify expected pages exist
32+
run: |
33+
test -f dist/index.html
34+
test -f dist/intro/index.html
35+
test -f dist/pillars/identity/index.html
36+
test -f dist/sdks/javascript/index.html
37+
test -d dist/_astro
38+
echo "✓ All key pages built"

‎CODE_OF_CONDUCT.md‎

Lines changed: 35 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,35 @@
1+
# Contributor Covenant Code of Conduct
2+
3+
## Our pledge
4+
5+
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, religion, or sexual identity and orientation.
6+
7+
We pledge to act and interact in ways that contribute to an open, welcoming, diverse, inclusive, and healthy community.
8+
9+
## Our standards
10+
11+
Examples of behaviour that contributes to a positive environment:
12+
13+
- Demonstrating empathy and kindness toward other people
14+
- Being respectful of differing opinions, viewpoints, and experiences
15+
- Giving and gracefully accepting constructive feedback
16+
- Accepting responsibility and apologising to those affected by our mistakes
17+
- Focusing on what is best for the overall community
18+
19+
Examples of unacceptable behaviour:
20+
21+
- Sexualised language or imagery, and sexual attention of any kind
22+
- Trolling, insulting or derogatory comments, personal or political attacks
23+
- Public or private harassment
24+
- Publishing others' private information without explicit permission
25+
- Other conduct which could reasonably be considered inappropriate in a professional setting
26+
27+
## Enforcement
28+
29+
Instances of abusive, harassing, or otherwise unacceptable behaviour may be reported to the maintainers responsible for enforcement at **conduct@tkawen.com** (or `DIRECTION@takawen.dz`). All complaints will be reviewed and investigated promptly and fairly.
30+
31+
All maintainers are obligated to respect the privacy and security of the reporter of any incident.
32+
33+
## Attribution
34+
35+
This Code of Conduct is adapted from the [Contributor Covenant](https://www.contributor-covenant.org), version 2.1, available at <https://www.contributor-covenant.org/version/2/1/code_of_conduct.html>.

0 commit comments

Comments
 (0)