text
stringlengths 56
11.6k
| source
stringlengths 10
64
|
|---|---|
# Project Management
We use the [Jan Monorepo Project](https://github.com/orgs/janhq/projects/5) in Github to manage our roadmap and sprint Kanbans.
As much as possible, everyone owns their respective `epics` and `tasks`.
:::tip
We aim for a `loosely coupled, but tightly aligned` autonomous culture.
:::
## Quicklinks
- [High-level roadmap](https://github.com/orgs/janhq/projects/5/views/16): view used at at strategic level, for team wide alignment. Start & end dates reflect engineering implementation cycles. Typically product & design work preceeds these timelines.
- [Standup Kanban](https://github.com/orgs/janhq/projects/5/views/25): view used during daily standup. Sprints should be up to date.
## Organization
[`Roadmap Labels`](https://github.com/janhq/jan/labels?q=roadmap)
- `Roadmap Labels` tag large, long-term, & strategic projects that can span multiple teams and multiple sprints
- Example label: `roadmap: Jan has Mobile`
- `Roadmaps` contain `epics`
[`Epics`](https://github.com/janhq/jan/issues?q=is%3Aissue+is%3Aopen+label%3A%22type%3A+epic%22)
- `Epics` track large stories that span 1-2 weeks, and it outlines specs, architecture decisions, designs
- `Epics` contain `tasks`
- `Epics` should always have 1 owner
[`Milestones`](https://github.com/janhq/jan/milestones)
- `Milestones` track release versions. We use [semantic versioning](https://semver.org/)
- `Milestones` span ~2 weeks and have deadlines
- `Milestones` usually fit within 2-week sprint cycles
[`Tasks`](https://github.com/janhq/jan/issues)
- Tasks are individual issues (feats, bugs, chores) that can be completed within a few days
- Tasks, except for critical bugs, should always belong to an `epic` (and thus fit into our roadmap)
- Tasks are usually named per [Conventional Commits](https://www.conventionalcommits.org/en/v1.0.0/#summary)
- Tasks should always have 1 owner
We aim to always sprint on `tasks` that are a part of the [current roadmap](https://github.com/orgs/janhq/projects/5/views/16).
## Kanban
- `no status`: issues that need to be triaged (needs an owner, ETA)
- `icebox`: issues you don't plan to tackle yet
- `planned`: issues you plan to tackle this week
- `in-progress`: in progress
- `in-review`: pending PR or blocked by something
- `done`: done
## Triage SOP
- `Urgent bugs`: assign to an owner (or @engineers if you are not sure) && tag the current `sprint` & `milestone`
- `All else`: assign the correct roadmap `label(s)` and owner (if any)
#### Request for help
As a result, our feature prioritization can feel a bit black box at times.
We'd appreciate high quality insights and volunteers for user interviews through [Discord](https://discord.gg/af6SaTdzpx) and [Github](https://github.com/janhq). | https://jan.ai/how-we-work/project-management/project-management |
# Strategy
We only have 2 planning parameters:
- 10 year vision
- 2 week sprint
- Quarterly OKRs
### Ideal Customer
Our ideal customer is an AI enthusiast or business who has experienced some limitations with current AI solutions and is keen to find open source alternatives.
### Problems
Our ideal customer would use Jan to solve one of these problems.
_Control_
- Control (e.g. preventing vendor lock-in)
- Stability (e.g. runs predictably every time)
- Local-use (e.g. for speed, or for airgapped environments)
_Privacy_
- Data protection (e.g. personal data or company data)
- Privacy (e.g. nsfw)
_Customisability_
- Tinkerability (e.g. ability to change model, experiment)
- Niche Models (e.g. fine-tuned, domain-specific models that outperform OpenAI)
Sources: [^1] [^2] [^3] [^4]
[^1]: [What are you guys doing that can't be done with ChatGPT?](https://www.reddit.com/r/LocalLLaMA/comments/17mghqr/comment/k7ksti6/?utm_source=share&utm_medium=web2x&context=3)
[^2]: [What's your main interest in running a local LLM instead of an existing API?](https://www.reddit.com/r/LocalLLaMA/comments/1718a9o/whats_your_main_interest_in_running_a_local_llm/)
[^3]: [Ask HN: What's the best self-hosted/local alternative to GPT-4?](https://news.ycombinator.com/item?id=36138224)
[^4]: [LoRAs](https://www.reddit.com/r/LocalLLaMA/comments/17mghqr/comment/k7mdz1i/?utm_source=share&utm_medium=web2x&context=3)
### Solution
Jan is a seamless user experience that runs on your personal computer, that glues the different pieces of the open source AI ecosystem to provide an alternative to OpenAI's closed platform.
- We build a comprehensive, seamless platform that takes care of the technical chores across the stack required to run open source AI
- We run on top of a local folder of non-proprietary files, that anyone can tinker with (yes, even other apps!)
- We provide open formats for packaging and distributing AI to run reproducibly across devices
## Prerequisites
- [Figma](https://figma.com)
- [ScreenStudio](https://www.screen.studio/) | https://jan.ai/how-we-work/strategy/strategy |
# Engineering
## Prerequisites
- [Requirements](https://github.com/janhq/jan?tab=readme-ov-file#requirements-for-running-jan)
- [Setting up local env](https://github.com/janhq/jan?tab=readme-ov-file#contributing) | https://jan.ai/engineering |
# CI & CD
## Gitflow
Previously we were trunk based. Now we use the following Gitflow:
TODO: @van to include her Mermaid diagram | https://jan.ai/engineering/ci-cd |
# QA
### Phase 1: Planning
#### Definition of Ready (DoR):
- [ ] **Scope Defined:** The features to be implemented are clearly defined and scoped out.
- [ ] **Requirements Gathered:** Gather and document all the necessary requirements for the feature.
- [ ] **Stakeholder Input:** Ensure relevant stakeholders have provided input on the document scope and content.
#### Definition of Done (DoD):
- [ ] **Document Complete:** All sections of the document are filled out with relevant information.
- [ ] **Reviewed by Stakeholders:** The document has been reviewed and approved by stakeholders.
- [ ] **Ready for Development:** The document is in a state where developers can use it to begin implementation.
### Phase 2: Development
#### Definition of Ready (DoR):
- [ ] **Task Breakdown:** The development team has broken down tasks based on the document.
- [ ] **Communication Plan:** A plan is in place for communication between developers and writers if clarification is needed during implementation.
- [ ] **Developer Understanding:** Developers have a clear understanding of the document content.
#### Definition of Done (DoD):
- [ ] **Code Implementation:** The feature is implemented according to the document specifications.
- [ ] **Developer Testing:**
- Unit tests and basic integration tests are completed
- Developer also completed self-testing for the feature (please add this as a comment in the ticket, with the tested OS and as much info as possible to reduce overlaping effort).
- (AC -> Code Changes -> Impacted scenarios)
- [ ] **Communication with Writers:** Developers have communicated any changes or challenges to the writers, and necessary adjustments are made in the document. (Can be through a note in the PR of the feature for writers to take care, or create a separate PR with the change you made for the docs, for writers to review)
### Phase 3: QA for feature
#### Definition of Ready (DoR):
- [ ] **Test Note Defined:** The test note is prepared outlining the testing items.
- [ ] **Environment Ready:** PR merged to nightly build, Nightly build notes updated (automatically from pipeline after merged).
- [ ] **Status:** Ticket moved to the column Testing and assigning to QA/writers to review.
- [ ] **Test Data Prepared:** Relevant test data is prepared for testing the scenarios.
#### Definition of Done (DoD):
- [ ] **Test Executed:** All identified test items are executed on different OS, along with exploratory testing.
- [ ] **Defects Logged:** Any defects found during testing are resolved / appropriately logged (and approved for future fix).
- [ ] **Test Sign-Off:** QA team provides sign-off indicating the completion of testing.
### Phase 4: Release (DoR)
- [ ] **Pre-release wait time:** Code change to pre-release version should be frozen for at least X (hrs/days) for Regression testing purpose.
- Pre-release cut off on Thu morning for the team to regression test.
- Release to production (Stable) during working hour on Mon morning (if no blocker) or Tue morning.
- During the release cut off, the nightly build will be paused, to leave room for pre-release build. The build version used for regression test will be notified.
- [ ] **Pre-release testing:** A review of the implemented feature has been conducted, a long with regression test (check-list) by the team.
- Release checklist cloned from the templat for different OS (with hackMD link)
- New key test items from new feature added to the checklist.
- Split 3 OS to different team members for testing.
- [ ] **Document Updated:** The document is updated based on the review and feedback on any discrepancies or modification needed for this release.
- [ ] **Reviewed by Stakeholders:** New feature and the updated document is reviewed and approved by stakeholders. The document is in its final version, reflecting the implemented feature accurately.
### Notes (WIP)
- [ ] **API collection run:** to run along with nightly build daily, for critical API validation
- [ ] **Automation run:** for regression testing purpose, to reduce manual testing effort for the same items each release on multiple OS. | https://jan.ai/engineering/qa |
# Product & Design
## Roadmap
- Conversations over Tickets
- Discord's #roadmap channel
- Work with the community to turn conversations into Product Specs
- Future System?
- Use Canny? | https://jan.ai/how-we-work/product-design/product-design |
# Jan Desktop
# Turn any computer into an AI computer
<!-- TODO replace with GIF when we turn this page into a website -->
### Designed for Everyone
- **Installs with 1 click.** Jan is easy to use, beautiful, and the core features are free forever.
- **Runs on consumer laptops.** Tested by 250k+ users across `Windows, Mac, and Linux`, Jan even works on `CPU-only mode`.
- **Automatic GPU acceleration**. Models responds faster across `NVIDIA, AMD, Apple, and Intel` when benchmarked against industry alternatives.
:::tip
“Normies” can run LLMs like an AI engineer on the Desktop App - no programming experience needed.
:::
### Private & Offline
- **Runs 100% locally**. AI models run directly on your laptop without an internet connection. `You own your AI`.
- **Private conversations.** Data is saved on your own filesystem in a transparent non-proprietary data format. `You own your data.`
- **Open source security**. Jan is open source, so you can scruntinize every line in our codebase. So when we say your data is not our product, we mean it. See [the code](https://github.com/janhq/jan) and our [data policy](/how-we-work/analytics).
### Customizable AI
- **Use AI without limitations.** Take control of censorship levels. Jan is usable from the classroom to the boardroom (and few other rooms if that’s your jam).
- **Use any models**. Download open source models from HuggingFace or upload your own custom models. [link]
:::tip
Download Jan Desktop Client [here](https://github.com/janhq/jan?tab=readme-ov-file#download).
:::
## Jan Desktop is
### For Developers
**You can easily integrate a locally running LLM into your own projects.**
- Turn on `Local API Server` mode to start building on an `OpenAI compatible API`.
- Jan Desktop comes with a Developer Console out of the box.
- The UI makes it easy to see logs, configure models and more.
<!-- CTA ⇒ Developer Hub -->
### For Your Home Server
<!-- [Insert Screenshot of: Jan running in a Terminal (left) || the OpenAI configuration Yaml (right)] -->
- Use Jan as a UI only, pointing to a different backend. [See Docs](/guides/using-models/integrate-with-remote-server)
- Use Jan as a backend only, pointing to a different frontend. [See Docs](/guides/using-models/integrate-with-remote-server)
- Run Jan in team-mode on production-grade GPUs. [See Server Suite](/server-suite)
<!-- CTA ⇒ Server Docs -->
### For People who Tinker
- Customize the app’s look and feel though Themes.
- Customize assistants, models and other features with **no code**.
- Customize the entire Application through Extensions. Inspired by VSCode extensions, the desktop app can be entirely customized.
[See the default extensions](https://github.com/janhq/jan/tree/main/extensions) bundled with every Desktop install.
 | https://jan.ai/desktop |
Subsets and Splits
No community queries yet
The top public SQL queries from the community will appear here once available.