Skip to content

Commit 4d4ef1b

Browse files
abhicrisclaude
andcommitted
Add CONTRIBUTING.md, CI workflow, issue/PR templates
- CONTRIBUTING.md: setup guide, code style, PR process - GitHub Actions CI: cargo check, test, clippy, fmt on every push/PR - Issue templates: feature request + bug report - PR template with checklist Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
1 parent 6def6a7 commit 4d4ef1b

5 files changed

Lines changed: 88 additions & 0 deletions

File tree

.github/ISSUE_TEMPLATE/bug.md

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
---
2+
name: Bug Report
3+
about: Report a bug
4+
title: '[Bug] '
5+
labels: 'bug'
6+
---
7+
## Describe the Bug
8+
## Steps to Reproduce
9+
## Expected Behavior
10+
## Environment
11+
- OS:
12+
- Rust version:
13+
- arka version:

.github/ISSUE_TEMPLATE/feature.md

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
---
2+
name: Feature Request
3+
about: Suggest a new feature
4+
title: '[Feature] '
5+
labels: 'help-wanted'
6+
---
7+
## Summary
8+
## Motivation
9+
## Proposed Solution

.github/pull_request_template.md

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
## What
2+
<!-- What does this PR do? -->
3+
4+
## Why
5+
<!-- Why is this change needed? -->
6+
7+
## How to Test
8+
<!-- Steps to verify the change -->
9+
10+
## Checklist
11+
- [ ] `cargo test` passes
12+
- [ ] `cargo clippy` passes
13+
- [ ] Docs updated if API changed

.github/workflows/ci.yml

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
name: CI
2+
on: [push, pull_request]
3+
jobs:
4+
check:
5+
runs-on: ubuntu-latest
6+
steps:
7+
- uses: actions/checkout@v4
8+
- uses: dtolnay/rust-toolchain@stable
9+
- run: cargo check --all-features
10+
- run: cargo test
11+
- run: cargo clippy -- -D warnings
12+
- run: cargo fmt -- --check

CONTRIBUTING.md

Lines changed: 41 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,41 @@
1+
# Contributing to arka
2+
3+
Thanks for your interest in contributing! arka is a [kcolbchain](https://kcolbchain.com) open-source project.
4+
5+
## Quick Start
6+
7+
```bash
8+
git clone https://github.com/YOUR_USERNAME/arka.git
9+
cd arka
10+
cargo build
11+
cargo test
12+
```
13+
14+
## Finding Work
15+
16+
- [Open issues](https://github.com/kcolbchain/arka/issues)
17+
- `good-first-issue` — great starting points
18+
- `help-wanted` — needs community help
19+
- Comment on an issue before starting work
20+
21+
## Code Style
22+
23+
- `cargo fmt` before committing
24+
- `cargo clippy` should pass with no warnings
25+
- Write doc comments for public functions
26+
- Add tests for new functionality
27+
28+
## PR Process
29+
30+
1. One feature/fix per PR
31+
2. `cargo test` must pass
32+
3. `cargo clippy` must pass
33+
4. Update README if you changed the API
34+
35+
## Community
36+
37+
- [kcolbchain.com](https://kcolbchain.com) | [Join](https://kcolbchain.com/join.html) | [GitHub](https://github.com/kcolbchain)
38+
39+
## License
40+
41+
MIT — contributions licensed under the same.

0 commit comments

Comments
 (0)