Skip to content

Commit 20511b4

Browse files
KonstantinKaiKonstantinKai
committed
Add CI workflow, community files, and editorconfig
1 parent ce8465d commit 20511b4

12 files changed

Lines changed: 153 additions & 1 deletion

File tree

‎.editorconfig‎

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
root = true
2+
3+
[*]
4+
end_of_line = lf
5+
insert_final_newline = true
6+
charset = utf-8
7+
indent_style = space
8+
indent_size = 4
9+
trim_trailing_whitespace = true

‎.github/FUNDING.yml‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
github: peekapi-dev

‎.github/ISSUE_TEMPLATE/bug_report.yml‎

Lines changed: 39 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,39 @@
1+
name: Bug Report
2+
description: Report a bug
3+
labels: [bug]
4+
body:
5+
- type: textarea
6+
id: description
7+
attributes:
8+
label: Description
9+
description: A clear description of the bug.
10+
validations:
11+
required: true
12+
- type: textarea
13+
id: steps
14+
attributes:
15+
label: Steps to Reproduce
16+
description: Steps to reproduce the behavior.
17+
validations:
18+
required: true
19+
- type: textarea
20+
id: expected
21+
attributes:
22+
label: Expected Behavior
23+
description: What you expected to happen.
24+
validations:
25+
required: true
26+
- type: input
27+
id: sdk-version
28+
attributes:
29+
label: SDK Version
30+
placeholder: "0.1.0"
31+
validations:
32+
required: true
33+
- type: input
34+
id: runtime-version
35+
attributes:
36+
label: Rust Version
37+
placeholder: "1.92"
38+
validations:
39+
required: true

‎.github/ISSUE_TEMPLATE/feature_request.yml‎

Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,25 @@
1+
name: Feature Request
2+
description: Suggest a feature
3+
labels: [enhancement]
4+
body:
5+
- type: textarea
6+
id: description
7+
attributes:
8+
label: Description
9+
description: What would you like to see added?
10+
validations:
11+
required: true
12+
- type: textarea
13+
id: use-case
14+
attributes:
15+
label: Use Case
16+
description: Why do you need this feature?
17+
validations:
18+
required: true
19+
- type: textarea
20+
id: proposed-solution
21+
attributes:
22+
label: Proposed Solution
23+
description: How would you like it to work?
24+
validations:
25+
required: false

‎.github/PULL_REQUEST_TEMPLATE.md‎

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
## Summary
2+
3+
<!-- What does this PR do? -->
4+
5+
## Checklist
6+
7+
- [ ] Tests pass
8+
- [ ] No breaking changes (or documented in description)

‎.github/workflows/ci.yml‎

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

‎CHANGELOG.md‎

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
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/).
6+
7+
## [0.1.0] - 2025-06-01
8+
9+
- Initial release

‎CODE_OF_CONDUCT.md‎

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
# Code of Conduct
2+
3+
This project follows the [Contributor Covenant v2.1](https://www.contributor-covenant.org/version/2/1/code_of_conduct/).
4+
5+
Please report unacceptable behavior to **security@peekapi.dev**.

‎LICENSE‎

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
MIT License
2+
3+
Copyright (c) 2025 PeekAPI
4+
5+
Permission is hereby granted, free of charge, to any person obtaining a copy
6+
of this software and associated documentation files (the "Software"), to deal
7+
in the Software without restriction, including without limitation the rights
8+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9+
copies of the Software, and to permit persons to whom the Software is
10+
furnished to do so, subject to the following conditions:
11+
12+
The above copyright notice and this permission notice shall be included in all
13+
copies or substantial portions of the Software.
14+
15+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21+
SOFTWARE.

‎README.md‎

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,7 @@
22

33
[![crates.io](https://img.shields.io/crates/v/peekapi)](https://crates.io/crates/peekapi)
44
[![license](https://img.shields.io/crates/l/peekapi)](./LICENSE)
5+
[![CI](https://github.com/peekapi-dev/sdk-rust/actions/workflows/ci.yml/badge.svg)](https://github.com/peekapi-dev/sdk-rust/actions/workflows/ci.yml)
56

67
Rust SDK for [PeekAPI](https://peekapi.dev). Thread-based buffered client with feature-gated middleware for Actix Web, Axum, and Rocket.
78

@@ -172,6 +173,14 @@ The callback receives a header-getter closure (`&dyn Fn(&str) -> Option<String>`
172173

173174
- Rust 2021 edition
174175

176+
## Contributing
177+
178+
1. Fork & clone the repo
179+
2. Run tests — `cargo test`
180+
3. Lint — `cargo clippy --all-features`
181+
4. Format — `cargo fmt`
182+
5. Submit a PR
183+
175184
## License
176185

177186
MIT

0 commit comments

Comments
 (0)