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
Binary file added .gitbook/assets/screenshots/ai-assist.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added .gitbook/assets/screenshots/board-view.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added .gitbook/assets/screenshots/calendar-view.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added .gitbook/assets/screenshots/dashboard.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added .gitbook/assets/screenshots/list-view.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added .gitbook/assets/screenshots/settings.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added .gitbook/assets/screenshots/task-detail.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added .gitbook/assets/screenshots/workload-report.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
22 changes: 22 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -36,6 +36,28 @@ Examples:
- `refactor/api-layer`


## Commit Message Format

We follow [Conventional Commits](https://www.conventionalcommits.org/) for all commit messages and PR titles. CI enforces this automatically.

**Format:**

```
<type>(<optional-scope>): <short description>
```

**Examples:**

- `feat(workload-report): add weekly view`
- `fix(auth): correct JWT expiry handling`
- `docs(readme): add Docker quick start`
- `chore: bump dependencies`

**Accepted types:** `feat`, `fix`, `refactor`, `chore`, `docs`, `perf`, `test`, `ci`, `build`, `style`, `revert`.

See [`commitlint.config.js`](commitlint.config.js) for the full configuration. Run `npm run lint:commits` to check your commits locally before pushing.


## Testing Requirements
- All new features must include tests where applicable
- Bug fixes should include regression coverage
Expand Down
263 changes: 242 additions & 21 deletions README.md

Large diffs are not rendered by default.

86 changes: 86 additions & 0 deletions SUPPORT.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,86 @@
# Support

Need help with AlianHub? Here's where to go for what.

---

## Where to ask

| What you need | Where to go |
|---|---|
| **Read the docs** | 📘 [help.alianhub.com](https://help.alianhub.com) — official user guide and API reference |
| **Try the app** | 🎮 [demo.alianhub.com](https://demo.alianhub.com) — live demo, no signup |
| **Ask a usage question** | 💬 [GitHub Discussions → Q&A](https://github.com/aliansoftwareteam/AlianHub-Project-Management-System/discussions/categories/q-a) |
| **Share an idea** | 💡 [GitHub Discussions → Ideas](https://github.com/aliansoftwareteam/AlianHub-Project-Management-System/discussions/categories/ideas) |
| **Show off what you built** | 🎉 [GitHub Discussions → Show and tell](https://github.com/aliansoftwareteam/AlianHub-Project-Management-System/discussions/categories/show-and-tell) |
| **Report a bug** | 🐛 [Open a Bug Report issue](https://github.com/aliansoftwareteam/AlianHub-Project-Management-System/issues/new?template=bug_report.yml) |
| **Request a feature** | 🚀 [Open a Feature Request issue](https://github.com/aliansoftwareteam/AlianHub-Project-Management-System/issues/new?template=feature_request.yml) |
| **Improve documentation** | 📝 [Open a Documentation issue](https://github.com/aliansoftwareteam/AlianHub-Project-Management-System/issues/new?template=documentation.yml) |
| **Report a security vulnerability** | 🔒 [GitHub Security Advisory](https://github.com/aliansoftwareteam/AlianHub-Project-Management-System/security/advisories/new) — please do NOT open a public issue |
| **Commercial / enterprise support** | 📧 [support@aliansoftware.net](mailto:support@aliansoftware.net) |

---

## Before opening an issue

Save time for yourself and maintainers by checking:

1. **The [documentation](https://help.alianhub.com)** — covers most common questions
2. **Existing [issues](https://github.com/aliansoftwareteam/AlianHub-Project-Management-System/issues?q=is%3Aissue)** and [closed issues](https://github.com/aliansoftwareteam/AlianHub-Project-Management-System/issues?q=is%3Aissue+is%3Aclosed) — your problem may already be reported or fixed
3. **[GitHub Discussions](https://github.com/aliansoftwareteam/AlianHub-Project-Management-System/discussions)** — usage questions often live here, not in Issues

---

## What to include in a bug report

A complete bug report helps us reproduce and fix the issue faster:

- **Version** — output of `npm run check-version` or the AlianHub version shown in the UI
- **Environment** — Node.js version, OS, MongoDB version, storage backend (`server` / `wasabi`)
- **Steps to reproduce** — what you did, in order
- **Expected behavior** — what should have happened
- **Actual behavior** — what actually happened (error messages, screenshots, server logs)
- **Minimal reproduction** — if possible, isolate the issue to its smallest reproducible form

The [Bug Report issue template](https://github.com/aliansoftwareteam/AlianHub-Project-Management-System/issues/new?template=bug_report.yml) asks for these fields.

---

## Response expectations

AlianHub is maintained primarily by Alian Software, with community contributions. We aim to:

- ✅ Acknowledge new issues within **3–5 business days**
- ✅ Acknowledge security reports within **72 hours** (see [SECURITY.md](SECURITY.md))
- ✅ Review pull requests within **5–10 business days**
- ⚠️ **No SLA on fixes or feature implementation** — community-driven projects work best when community contributions land alongside maintainer-led work

If your issue is time-sensitive for a production deployment, consider [commercial support](mailto:support@aliansoftware.net).

---

## Commercial support

For organizations that need:

- 🏢 **Priority issue resolution** with response-time SLAs
- 🔐 **Compliance / legal assistance** — closed-source alternative licensing, audit support
- 🛠️ **Custom development** — features built on your timeline
- 🎓 **Onboarding & training** — for teams adopting AlianHub
- ☁️ **Managed hosting** — fully hosted AlianHub instances

📧 Contact **[support@aliansoftware.net](mailto:support@aliansoftware.net)** for a conversation.

---

## Stay in the loop

- ⭐ **Star the repo** to show support and stay updated on releases
- 👀 **Watch the repo** to get notified on issues, PRs, and releases
- 📰 **Follow the [releases page](https://github.com/aliansoftwareteam/AlianHub-Project-Management-System/releases)** for changelogs

---

## Code of Conduct

All community interactions are governed by our [Code of Conduct](CODE_OF_CONDUCT.md). Please be kind, be patient, and assume good intent.
Loading