Skip to content

Commit 1a7e7cc

Browse files
saltines321-debugsaltines321-debug
authored
Merge branch 'main' into codex/github-mention-template-devex]-automation,-ci/cd-contrib
2 parents 722865f + 470cd3b commit 1a7e7cc

6 files changed

Lines changed: 153 additions & 24 deletions

File tree

‎.editorconfig‎

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
root = true
2+
3+
[*]
4+
charset = utf-8
5+
end_of_line = lf
6+
insert_final_newline = true
7+
indent_style = space
8+
indent_size = 2
9+
trim_trailing_whitespace = true
10+
11+
[*.md]
12+
trim_trailing_whitespace = false
13+
14+
[Makefile]
15+
indent_style = tab

‎.gitattributes‎

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
* text=auto eol=lf
2+
3+
*.sh text eol=lf
4+
*.ps1 text eol=crlf
5+
6+
*.png binary
7+
*.jpg binary
8+
*.jpeg binary
9+
*.gif binary
10+
*.pdf binary

‎.github/ISSUE_TEMPLATE/config.yml‎

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
blank_issues_enabled: false
2+
contact_links:
3+
- name: Security reports
4+
url: mailto:security@example.com
5+
about: Report security vulnerabilities privately.
6+
- name: Contribution guide
7+
url: https://github.com/OWNER/REPO/blob/main/CONTRIBUTING.md
8+
about: Read contribution expectations and workflow guidance.

‎.gitignore‎

Lines changed: 51 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,51 @@
1+
# OS-generated files
2+
.DS_Store
3+
Thumbs.db
4+
5+
# Editor and IDE directories
6+
.vscode/
7+
.idea/
8+
*.swp
9+
*.swo
10+
11+
# Logs
12+
*.log
13+
logs/
14+
15+
# Environment variables and local config
16+
.env
17+
.env.*
18+
*.local
19+
20+
# Dependency directories
21+
node_modules/
22+
.vendor/
23+
24+
# Build and distribution artifacts
25+
dist/
26+
build/
27+
out/
28+
coverage/
29+
*.tmp
30+
*.temp
31+
32+
# Python
33+
__pycache__/
34+
*.py[cod]
35+
.venv/
36+
venv/
37+
38+
# Java
39+
*.class
40+
41+
# Go
42+
bin/
43+
44+
# Rust
45+
target/
46+
47+
# Package manager lockfiles for library templates (optional)
48+
# Uncomment as needed for application repos:
49+
# package-lock.json
50+
# yarn.lock
51+
# pnpm-lock.yaml

‎README.md‎

Lines changed: 1 addition & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -63,29 +63,6 @@ See `docs/REPOSITORY_STANDARDS.md` for reusable naming and governance convention
6363

6464
## Suggested next steps
6565

66-
- Review prebuilt GitHub Actions workflows in `.github/workflows/` and enable commands for your stack.
66+
- Add CI workflows in `.github/workflows/`.
6767
- Add language/tool-specific linting and formatting.
6868
- Add architecture and operations documentation in `docs/`.
69-
- Configure `release.yml` for semantic release PRs/tags if you publish artifacts.
70-
71-
## Repository layout
72-
73-
```
74-
.github/
75-
ISSUE_TEMPLATE/
76-
PULL_REQUEST_TEMPLATE.md
77-
CODEOWNERS
78-
CHANGELOG.md
79-
CODE_OF_CONDUCT.md
80-
CONTRIBUTING.md
81-
LICENSE
82-
SECURITY.md
83-
```
84-
85-
## Automation included
86-
87-
- Reusable quality workflow: `.github/workflows/reusable-quality.yml`
88-
- CI entry workflow: `.github/workflows/ci.yml`
89-
- Release automation workflow: `.github/workflows/release.yml`
90-
- Bootstrap script: `scripts/bootstrap.sh`
91-
- Developer setup guide: `docs/developer-setup.md`

‎docs/REPOSITORY_STANDARDS.md‎

Lines changed: 68 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,68 @@
1+
# Repository Standards
2+
3+
This document defines reusable standards for repository governance, naming, and release hygiene.
4+
5+
## Branch strategy
6+
7+
- Default branch: `main`
8+
- Short-lived feature branches:
9+
- `feat/<short-description>`
10+
- `fix/<short-description>`
11+
- `chore/<short-description>`
12+
- `docs/<short-description>`
13+
14+
## Commit style
15+
16+
Recommended commit prefixes:
17+
18+
- `feat:` new functionality
19+
- `fix:` bug fixes
20+
- `docs:` documentation-only changes
21+
- `chore:` maintenance and tooling
22+
- `refactor:` internal improvements
23+
- `test:` test additions/updates
24+
25+
## Pull request standards
26+
27+
- Keep changes focused and reviewable.
28+
- Link related issue(s) in PR description.
29+
- Include validation steps and expected outcomes.
30+
- Update docs/changelog when behavior changes.
31+
32+
## Label taxonomy
33+
34+
Use a minimal, reusable label set:
35+
36+
- Type labels:
37+
- `type: bug`
38+
- `type: feature`
39+
- `type: docs`
40+
- `type: chore`
41+
- Priority labels:
42+
- `priority: p0`
43+
- `priority: p1`
44+
- `priority: p2`
45+
- Status labels:
46+
- `status: needs-triage`
47+
- `status: blocked`
48+
- `status: ready`
49+
50+
## Milestone strategy
51+
52+
Recommended milestone model:
53+
54+
- Time-based milestones (e.g., `2026-Q3`) for ongoing teams.
55+
- Version-based milestones (e.g., `v1.4.0`) for release-driven projects.
56+
- Keep milestone scope small enough for predictable closure.
57+
58+
## Release strategy
59+
60+
- Follow Semantic Versioning.
61+
- Maintain `CHANGELOG.md` for notable changes.
62+
- Tag releases with `vX.Y.Z`.
63+
64+
## Documentation standards
65+
66+
- Use clear headings (`#`, `##`, `###`) and concise sections.
67+
- Prefer task-oriented instructions for onboarding.
68+
- Keep placeholders explicit (`OWNER`, `REPO`, `security@example.com`).

0 commit comments

Comments
 (0)