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
3 changes: 3 additions & 0 deletions .github/CODEOWNERS
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
# Every change requires review from a listed code owner.
# See https://docs.github.com/en/repositories/managing-your-repositorys-settings-and-security/customizing-your-repository/about-code-owners
* @adibhanna
19 changes: 19 additions & 0 deletions .github/dependabot.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
version: 2
updates:
- package-ecosystem: npm
directory: /
schedule:
interval: weekly
open-pull-requests-limit: 10
labels:
- dependencies
- npm

- package-ecosystem: github-actions
directory: /
schedule:
interval: weekly
open-pull-requests-limit: 5
labels:
- dependencies
- github-actions
44 changes: 44 additions & 0 deletions .github/workflows/codeql.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,44 @@
name: CodeQL

on:
push:
branches: [main]
pull_request:
branches: [main]
schedule:
# Weekly scan on Sundays at 04:17 UTC so it doesn't fight the weekday CI queue.
- cron: '17 4 * * 0'

permissions:
actions: read
contents: read
security-events: write

jobs:
analyze:
name: Analyze (${{ matrix.language }})
runs-on: ubuntu-latest
timeout-minutes: 20

strategy:
fail-fast: false
matrix:
language: [javascript-typescript]

steps:
- name: Checkout
uses: actions/checkout@v4

- name: Initialize CodeQL
uses: github/codeql-action/init@v3
with:
languages: ${{ matrix.language }}
queries: security-and-quality

- name: Autobuild
uses: github/codeql-action/autobuild@v3

- name: Analyze
uses: github/codeql-action/analyze@v3
with:
category: '/language:${{ matrix.language }}'
66 changes: 66 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,66 @@
# Contributing to ZenNotes

Thanks for your interest in improving ZenNotes — a keyboard-first, Markdown-first
desktop notes app built on Electron, React, TypeScript, and CodeMirror 6.

## Before you start

- For **anything non-trivial**, open an issue first so we can agree on scope
and approach before you spend time building.
- For **small fixes** (typos, obvious bugs, dependency bumps), open a PR
directly.
- For **security issues**, do not open a public issue — follow
[SECURITY.md](./SECURITY.md).

## Getting set up

```bash
git clone https://github.com/ZenNotes/zennotes.git
cd zennotes
npm install
npm run dev
```

Useful scripts:

- `npm run dev` — run the app with hot reload
- `npm test` — run the test suite
- `npm run build` — produce a production build
- `npm run lint` — run the linter

## Working on a change

1. Fork the repo and create a feature branch from `main`.
2. Keep commits focused. A clear commit message beats a long PR description.
3. Add or update tests when you change behavior.
4. Make sure `npm test` and `npm run build` pass locally.
5. Open a pull request against `main`.

## Pull request requirements

Branch protection on `main` enforces:

- **Pull request required** — no direct pushes
- **One approving review from a code owner** (see
[.github/CODEOWNERS](./.github/CODEOWNERS))
- **Green CI** across Linux, macOS, and Windows build jobs
- **Linear history** (squash merge only; the head branch is auto-deleted)
- **All review comments resolved** before merging

## Style and scope

- Match the style of the surrounding code — don't introduce new patterns
mid-file.
- Keep the scope of each PR tight. Refactors, feature work, and formatting
changes belong in separate PRs.
- ZenNotes is keyboard-first. Every new user-facing feature should ship with a
keybinding or leader flow.

## Code of conduct

Be kind, assume good faith, focus on the work.

## License

By contributing, you agree that your contributions are licensed under the
[MIT License](./LICENSE).
21 changes: 21 additions & 0 deletions LICENSE
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
MIT License

Copyright (c) 2026 Adib Hanna and ZenNotes contributors

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.
22 changes: 22 additions & 0 deletions SECURITY.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
# Security Policy

## Supported Versions

We support the latest published release of ZenNotes. Security fixes land on
`main` first and roll into the next release.

## Reporting a Vulnerability

**Please do not open a public GitHub issue for security vulnerabilities.**

Report issues privately through GitHub's [private vulnerability reporting
form](https://github.com/ZenNotes/zennotes/security/advisories/new) for this
repository. Include:

- A description of the issue and the impact
- Steps to reproduce or a proof of concept
- Affected versions, if known
- Any suggested remediation

We aim to acknowledge reports within 3 business days and to ship a fix or
publish a coordinated advisory within 30 days of confirmation.
Loading