Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
26 changes: 26 additions & 0 deletions .github/.commitlintrc.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,26 @@
# SPDX-FileCopyrightText: 2025 hexaTune LLC
# SPDX-License-Identifier: MIT

extends:
- "@commitlint/config-conventional"

rules:
type-enum:
- 2
- always
- [
feat,
fix,
chore,
refactor,
test,
docs,
ci,
perf,
build,
release,
hotfix,
style,
]
header-max-length: [0, "always"]
body-max-line-length: [0, "never"]
35 changes: 35 additions & 0 deletions .github/CODEOWNERS
Original file line number Diff line number Diff line change
@@ -0,0 +1,35 @@
# SPDX-FileCopyrightText: 2025 hexaTune LLC
# SPDX-License-Identifier: MIT

# Default owner
* @husamettinarabaci

# Module-specific owners

## Firmware
/firmware/ @husamettinarabaci

## Hardware
/hardware/ @husamettinarabaci

## Mechanic
/mechanic/ @husamettinarabaci

## Documentation
/docs/ @husamettinarabaci

## Tests
/integration-tests/ @husamettinarabaci

## Benchmarks
/benchmarks/ @husamettinarabaci

## Examples
/examples/ @husamettinarabaci

## Scripts
/scripts/ @husamettinarabaci

## GitHub
/.github/ @husamettinarabaci

48 changes: 48 additions & 0 deletions .github/CODE_OF_CONDUCT.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,48 @@
<!--
SPDX-FileCopyrightText: 2025 hexaTune LLC
SPDX-License-Identifier: MIT
-->

# Contributor Covenant Code of Conduct

## 📜 Our Pledge

We as members, contributors, and leaders pledge to make participation in **hexaGenApp** an open, welcoming, diverse, inclusive, and harassment-free experience for everyone.

We commit to acting and interacting in ways that contribute to an open, respectful, and constructive community—regardless of age, body size, visible or invisible disability, ethnicity, sex characteristics, gender identity and expression, level of experience, education, socioeconomic status, nationality, personal appearance, race, religion, or sexual identity and orientation.

## ✅ Our Standards

Examples of behavior that contributes to a positive environment:

- Using welcoming and inclusive language
- Respecting different viewpoints and experiences
- Gracefully accepting constructive criticism
- Showing empathy toward others

Examples of unacceptable behavior:

- The use of sexualized language or imagery and unwelcome advances
- Trolling, insulting or derogatory comments, and personal or political attacks
- Public or private harassment
- Publishing others’ private information without explicit permission

## 🙋 Our Responsibilities

Project maintainers are responsible for clarifying the standards and enforcing them appropriately.

## 📞 Scope

This Code of Conduct applies to all community spaces—online and offline—including project repositories, issue trackers, forums, chat rooms, events, and social media.

## 🛡️ Enforcement

Instances of abusive or otherwise unacceptable behavior may be reported to the maintainers at:

📧 [info@hexatune.com](mailto:info@hexatune.com)

All reports will be reviewed and investigated, and will result in a response deemed necessary and appropriate to the circumstances.

## 📄 Attribution

This Code of Conduct is adapted from the [Contributor Covenant](https://www.contributor-covenant.org), version 2.0.
110 changes: 110 additions & 0 deletions .github/CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,110 @@
<!--
SPDX-FileCopyrightText: 2025 hexaTune LLC
SPDX-License-Identifier: MIT
-->

# Contributing to hexaGenApp

Thank you for your interest in contributing to **hexaGenApp**!
This document outlines how to get involved, contribute code or ideas, and follow our development process.

---

## 📚 Before You Start

Please review the following core documents:

- [Getting Started](https://github.com/hTuneSys/hexaGenApp/blob/main/docs/GETTING_STARTED.md)
- [Architecture](https://github.com/hTuneSys/hexaGenApp/blob/main/docs/ARCHITECTURE.md)
- [Branch Strategy](https://github.com/hTuneSys/hexaGenApp/blob/main/docs/BRANCH_STRATEGY.md)
- [Project Board](https://github.com/hTuneSys/hexaGenApp/blob/main/docs/PROJECT_BOARD.md)
- [FAQ](https://github.com/hTuneSys/hexaGenApp/blob/main/docs/FAQ.md)
- [README](https://github.com/hTuneSys/hexaGenApp#readme)

---

## 🧩 Contribution Types

- **Code:** New features, bugfixes, enhancements to modules or core
- **Plugins:** External integrations, reusable logic extensions
- **Docs:** Fixing typos, improving structure, or writing new guides
- **Issues & Feedback:** Filing issues, proposing ideas or improvements

---

## 🔀 Branch Strategy

Please follow our [Branching Guide](https://github.com/hTuneSys/hexaGenApp/blob/main/docs/BRANCH_STRATEGY.md)

- Always branch from `develop`
- Use one of the allowed types as prefix:
`feat/`, `fix/`, `chore/`, `refactor/`, `test/`, `docs/`, `ci/`, `perf/`, `build/`, `release/`, `hotfix/`, `style/`
- Example: `feat/auth-handler`, `fix/login-bug`, `docs/contributing`
- Never branch from `main`
- Only maintainers may merge to `main` or `release/*`

---

## ✏️ Commit & PR Formatting

All commits and pull requests must follow [Conventional Commits](https://www.conventionalcommits.org/):

### ✅ Allowed Types

`feat`, `fix`, `chore`, `refactor`, `test`, `docs`, `ci`, `perf`, `build`, `release`, `hotfix`, `style`

### 📝 Examples

```bash
feat: add user authentication module
fix: resolve panic on empty payload
chore: remove unused dependencies
refactor: simplify scheduler logic
test: add unit tests for HexaStore
docs: improve contributing guide
ci: update GitHub Actions for linting
perf: optimize event matching engine
build: update pubspec.yaml deps and app version
release: prepare v0.2.0 release
hotfix: patch critical runtime bug
style: reformat codebase with dart format
```

PR titles must follow the same format. Title linting is enforced.

---

## 🧪 PR Flow & Project Board

1. Choose or create an issue
2. Fork the repo and branch from `develop`
3. Submit a PR with a descriptive title
4. PR flows through:
- 🟡 In Progress
- 🔍 In Review
- ✅ Done

---

## 🏷 Label System

Labels are automatically assigned based on the module or type.
Refer to [Labelling Strategy](https://github.com/hTuneSys/hexaGenApp/blob/main/docs/LABELLING_STRATEGY.md)

---

## 🔁 CI/CD & Releases

- All PRs must pass checks (build, test, format, lint)
- PRs are merged into `develop`, then promoted to `release/*`
- Only merges into `main` trigger semantic-release automation

---

## 🙋 Support & Communication

- Questions? Use [GitHub Discussions](https://github.com/hTuneSys/hexaGenApp/discussions)
- For sensitive topics, contact **[info@hexatune.com](mailto:info@hexatune.com)**
- Please follow our [Code of Conduct](https://github.com/hTuneSys/hexaGenApp/blob/main/.github/CODE_OF_CONDUCT.md)

We’re excited to build hexaGenApp with your help 🚀
4 changes: 4 additions & 0 deletions .github/FUNDING.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
# SPDX-FileCopyrightText: 2025 hexaTune LLC
# SPDX-License-Identifier: MIT

github: hTuneSys
49 changes: 49 additions & 0 deletions .github/ISSUE_TEMPLATE/bug-report.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,49 @@
---
name: "\U0001F41B Bug Report"
about: Report a reproducible bug or unexpected behavior in hexaGenApp
title: "[bug]: Describe the problem clearly"
labels: [type:bug]
assignees: husamettinarabaci
---

**Describe the bug**
A clear and concise description of what the bug is.

**To Reproduce**
Steps to reproduce the behavior:

1. Go to '...'
2. Click on '....'
3. Scroll down to '....'
4. See error

**Expected behavior**
A clear and concise description of what you expected to happen.

**Screenshots**
If applicable, add screenshots to help explain your problem.

**Desktop (please complete the following information):**

- OS: [e.g. iOS]
- Browser [e.g. chrome, safari]
- Version [e.g. 22]

**Smartphone (please complete the following information):**

- Device: [e.g. iPhone6]
- OS: [e.g. iOS8.1]
- Browser [e.g. stock browser, safari]
- Version [e.g. 22]

**Additional context**
Add any other context about the problem here.

**Impact**
How critical is the bug? (e.g., crash, data loss, UI glitch)

**Severity**
What is the scope? (e.g., affects all users, only under rare conditions)

**Priority**
How soon should this be fixed? (e.g., urgent, normal, low)
4 changes: 4 additions & 0 deletions .github/ISSUE_TEMPLATE/config.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
# SPDX-FileCopyrightText: 2025 hexaTune LLC
# SPDX-License-Identifier: MIT

blank_issues_enabled: false
23 changes: 23 additions & 0 deletions .github/ISSUE_TEMPLATE/documentation.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
---
name: "📝 Documentation Issue"
about: Report an issue or suggest an improvement for the documentation
title: "[docs]: Clarify CONTRIBUTING.md section"
labels: [type:doc]
assignees: husamettinarabaci
---

### 📄 What part of the documentation is unclear or incorrect?

Please specify which page or section has a problem or could be improved.

---

### ✏️ Suggested Fix or Clarification

If you have suggestions for better wording or additional examples, please include them here.

---

### 🔗 Links or Screenshots

(Optional) Provide URLs, screenshots, or file references related to the issue.
25 changes: 25 additions & 0 deletions .github/ISSUE_TEMPLATE/feature-request.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
---
name: "\U0001F31F Feature Request"
about: Suggest a new feature or improvement for hexaGenApp
title: "[feat]: Suggest a new capability or improvement"
labels: [type:feature]
assignees: husamettinarabaci
---

**Is your feature request related to a problem? Please describe.**
A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]

**Describe the solution you'd like**
A clear and concise description of what you want to happen.

**Describe alternatives you've considered**
A clear and concise description of any alternative solutions or features you've considered.

**Additional context**
Add any other context or screenshots about the feature request here.

**Impact**
What benefit will this bring if implemented?

**Priority**
Is this critical, nice-to-have, or optional?
25 changes: 25 additions & 0 deletions .github/ISSUE_TEMPLATE/question.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
---
name: "❓ Question / Clarification"
about: Ask a question or request clarification about hexaGenApp usage or design
title: "[question]: Briefly summarize your question"
labels: [status:needs-spec]
assignees: husamettinarabaci
---

### 🤔 What is your question?

Please clearly describe the question or concept you're unclear about. Be as specific as possible.

---

### 📚 Context or Background

- What part of the system are you referring to?
- Are you following a particular example or tutorial?
- Have you checked the [README](https://github.com/hTuneSys/hexaGenApp/blob/main/README.md), [FAQ](https://github.com/hTuneSys/hexaGenApp/blob/main/docs/FAQ.md), or [full documentation](https://github.com/hTuneSys/hexaGenApp/main/develop/docs/DEVELOPMENT_GUIDE.md)?

---

### 💭 Additional Information

(Optional) Provide logs, screenshots, links, or anything else that might help clarify your question.
35 changes: 35 additions & 0 deletions .github/ISSUE_TEMPLATE/support.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,35 @@
---
name: "💬 Support Request"
about: Request general help, integration advice, or usage clarification for hexaGenApp
title: "[support]: Describe your need"
labels: [status:waiting-feedback]
assignees: husamettinarabaci
---

### 📚 What do you need help with?

Please describe the situation, problem, or question you have. Include as much context as possible:

- What are you trying to achieve?
- What specific part of hexaGenApp are you using?
- Are you following a particular tutorial or example?

---

### 💻 System Details (Optional)

- hexaGenApp version (if applicable):
- Platform or environment (if applicable):
- Device version (if relevant):

---

### 🧪 What have you tried so far?

Let us know what steps you've taken to solve the issue on your own.

---

### 📎 Additional Info

Add logs, screenshots, config files, or anything else that may help us assist you better.
Loading
Loading