Skip to content

Commit 386b291

Browse files
committed
Add changelog and contributing doc
1 parent 8dce1ae commit 386b291

File tree

2 files changed

+54
-0
lines changed

2 files changed

+54
-0
lines changed

CHANGELOG.md

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
# Changelog
2+
All notable changes to this project will be documented in this file.
3+
4+
## [Unreleased]
5+
6+
## [1.0.0] - 2025-08-27
7+
### Added
8+
- Initial build
9+
10+
11+
12+

CONTRIBUTING.md

Lines changed: 42 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,42 @@
1+
2+
# Contributing
3+
4+
Thank you for your interest in contributing!
5+
We welcome feedback, bug reports, and pull requests.
6+
7+
## How to Contribute
8+
9+
### 1. Reporting Issues
10+
11+
* Use the **[GitHub Issues tab](../../issues)** to report bugs, request features, or ask questions.
12+
* Please search existing issues before opening a new one to avoid duplicates.
13+
14+
### 2. Suggesting Improvements
15+
16+
* If you have ideas or feedback, open an **issue** with the label `enhancement` or `discussion`.
17+
* Include as much context as possible to help others understand your suggestion.
18+
19+
### 3. Submitting Code
20+
21+
We follow the standard GitHub **fork-and-pull request workflow**:
22+
23+
1. **Fork** the repository.
24+
2. **Create a branch** for your changes (`git checkout -b feature/your-feature-name`).
25+
3. **Make your changes** and commit them with clear messages.
26+
4. **Push** your branch to your fork.
27+
5. **Open a Pull Request (PR)** against the `main` branch.
28+
29+
> Please keep PRs focused and small when possible. This makes reviewing easier and speeds up merging.
30+
31+
### 4. Code Style
32+
33+
* Follow existing project conventions (naming, formatting, folder structure).
34+
* If in doubt, match the style you see in the repo.
35+
36+
### 5. Questions
37+
38+
If you’re unsure about something, feel free to open an issue and start a discussion.
39+
40+
---
41+
42+
Thanks again for contributing!

0 commit comments

Comments
 (0)