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
130 changes: 130 additions & 0 deletions .github/CODE_OF_CONDUCT.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,130 @@
# Contributor Covenant Code of Conduct

## Our Pledge

We as members, contributors, and leaders pledge to make participation in our
community a harassment-free experience for everyone, regardless of age, body
size, visible or invisible disability, ethnicity, sex characteristics, gender
identity and expression, level of experience, education, socio-economic status,
nationality, personal appearance, race, caste, color, religion, or sexual
identity and orientation.

We pledge to act and interact in ways that contribute to an open, welcoming,
diverse, inclusive, and healthy community.

## Our Standards

Examples of behavior that contributes to a positive environment for our
community include:

* Demonstrating empathy and kindness toward other people
* Being respectful of differing opinions, viewpoints, and experiences
* Giving and gracefully accepting constructive feedback
* Accepting responsibility and apologizing to those affected by our mistakes,
and learning from the experience
* Focusing on what is best not just for us as individuals, but for the overall
community

Examples of unacceptable behavior include:

* The use of sexualized language or imagery, and sexual attention or advances of
any kind
* Trolling, insulting or derogatory comments, and personal or political attacks
* Public or private harassment
* Publishing others' private information, such as a physical or email address,
without their explicit permission
* Other conduct which could reasonably be considered inappropriate in a
professional setting

This project deals with legal documents and, sometimes, with people handling
their own court filings. Treat anything a contributor shares about their case,
their filings, or their circumstances as private unless they say otherwise, and
never repost it elsewhere.

## Enforcement Responsibilities

Community leaders are responsible for clarifying and enforcing our standards of
acceptable behavior and will take appropriate and fair corrective action in
response to any behavior that they deem inappropriate, threatening, offensive,
or harmful.

Community leaders have the right and responsibility to remove, edit, or reject
comments, commits, code, wiki edits, issues, and other contributions that are
not aligned to this Code of Conduct, and will communicate reasons for moderation
decisions when appropriate.

## Scope

This Code of Conduct applies within all community spaces — issues, pull
requests, discussions, and commit history — and also applies when an individual
is officially representing the community in public spaces.

## Enforcement

Instances of abusive, harassing, or otherwise unacceptable behavior may be
reported to the maintainer, [@TheSaltyKorean](https://github.com/TheSaltyKorean).
If the report does not involve private information, open an issue; otherwise
contact the maintainer directly through GitHub, or use GitHub's
[report abuse](https://github.com/contact/report-abuse) form. All complaints
Comment on lines +67 to +68

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

P2 Badge Provide a private conduct-reporting channel

For reports involving private case details or maintainer conduct, this instruction leaves contributors without a way to contact the project privately: GitHub profiles do not provide direct messaging, and the linked Report Abuse form reports violations to GitHub rather than to this project's maintainer. Add a concrete private channel, such as a dedicated email address or private reporting form, so sensitive Code of Conduct complaints can actually reach the person responsible for enforcement.

Useful? React with 👍 / 👎.

will be reviewed and investigated promptly and fairly.

Community leaders are obligated to respect the privacy and security of the
reporter of any incident.

## Enforcement Guidelines

Community leaders will follow these Community Impact Guidelines in determining
the consequences for any action they deem in violation of this Code of Conduct:

### 1. Correction

**Community Impact**: Use of inappropriate language or other behavior deemed
unprofessional or unwelcome in the community.

**Consequence**: A private, written warning from community leaders, providing
clarity around the nature of the violation and an explanation of why the
behavior was inappropriate. A public apology may be requested.

### 2. Warning

**Community Impact**: A violation through a single incident or series of
actions.

**Consequence**: A warning with consequences for continued behavior. No
interaction with the people involved, including unsolicited interaction with
those enforcing the Code of Conduct, for a specified period of time. Violating
these terms may lead to a temporary or permanent ban.

### 3. Temporary Ban

**Community Impact**: A serious violation of community standards, including
sustained inappropriate behavior.

**Consequence**: A temporary ban from any sort of interaction or public
communication with the community for a specified period of time. Violating
these terms may lead to a permanent ban.

### 4. Permanent Ban

**Community Impact**: Demonstrating a pattern of violation of community
standards, including sustained inappropriate behavior, harassment of an
individual, or aggression toward or disparagement of classes of individuals.

**Consequence**: A permanent ban from any sort of public interaction within the
community.

## Attribution

This Code of Conduct is adapted from the [Contributor Covenant][homepage],
version 2.1, available at
<https://www.contributor-covenant.org/version/2/1/code_of_conduct.html>.

Community Impact Guidelines were inspired by
[Mozilla's code of conduct enforcement ladder][mozilla].

[homepage]: https://www.contributor-covenant.org
[mozilla]: https://github.com/mozilla/diversity

For answers to common questions about this code of conduct, see the FAQ at
<https://www.contributor-covenant.org/faq>. Translations are available at
<https://www.contributor-covenant.org/translations>.
92 changes: 92 additions & 0 deletions .github/CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,92 @@
# Contributing to Markdown Studio

Thanks for taking an interest. This is a small project with one maintainer, so
the fastest way to get a change in is to make it easy to review.

By participating you agree to the [Code of Conduct](CODE_OF_CONDUCT.md).

## Before you write code

- **Open an issue first for anything non-trivial.** A bug fix or a typo can go
straight to a pull request; a new feature, a dependency change, or a
refactor is worth agreeing on before you spend the time.
- **Check [`docs/ROADMAP.md`](../docs/ROADMAP.md)** — the feature may already be
planned, or deliberately out of scope.
- **Licensing.** The project is under the
[PolyForm Noncommercial License 1.0.0](../LICENSE.md). By opening a pull
request you agree your contribution is licensed on the same terms.

## Setting up

Full detail lives in [`docs/DEVELOPMENT.md`](../docs/DEVELOPMENT.md). The short
version:

```bash
fvm flutter pub get
fvm flutter run -d windows # or linux / macos / a connected device
```

**Flutter is pinned to 3.41.9** (see `.fvmrc`) — use FVM, or put a matching
SDK's `bin/` on your `PATH`. Flutter 3.44+ does **not** compile: it added
`TextInputClient.onFocusReceived`, which `appflowy_editor` 6.2.0 doesn't
implement. Note that `flutter analyze` passes on 3.44 even though the build
fails, so a clean analyze is not proof you're on the right SDK.

The native platform folders (`android/`, `ios/`, `linux/`, `macos/`,
`windows/`) can be regenerated with:

```bash
fvm flutter create --org com.markdownstudio --project-name markdown_studio \
--platforms=android,ios,linux,windows,macos .
```

A few dependencies are pinned or overridden on purpose — `file_picker` at 10.x
(see [issue #2](https://github.com/TheSaltyKorean/md/issues/2)), plus `intl`
and `path_provider_foundation` overrides. Don't bump them casually; the reasons
are in `pubspec.yaml` and `CLAUDE.md`.

## Before you open a pull request

Every change must satisfy all of these:

- [ ] `fvm flutter analyze` is clean.
- [ ] `fvm flutter test` is green.
- [ ] **The version is bumped in `pubspec.yaml`** (`x.y.z+buildNumber`, *both*
parts) if app behaviour changed at all — a bug fix, a rendering change, a
new feature. This rides in the same PR. An unbumped build is
indistinguishable from the last release, so the in-app updater reports
"no update found" and users never get the fix. Docs-only, CI-only and
website-only changes don't need one.
- [ ] **Cross-platform is preserved.** Linux, Windows, Android and iOS must all
still build. No platform-locked code without a guard.
- [ ] **Material 3 with light *and* dark themes** still works in any UI you
touched.
- [ ] **Printing still works**, including the themeable header/footer and the
per-document branding profiles. The print preview opens in a workspace
tab — never a modal dialog.
- [ ] New behaviour has a test. `test/widget_test.dart` is the main suite; the
PDF builder in particular is covered by rendering a document and
asserting on the resulting widget tree.

## Pull requests

Open a PR against `main` — `main` is protected, so direct pushes are rejected
and the **`Analyze & test`** check must pass before a merge. CI also builds
Linux, Windows, Android, iOS and macOS on every PR; those take a few minutes
longer than the analyze job.

Keep the README short (badges, download links, highlights) — details belong in
`docs/DEVELOPMENT.md`, `docs/RELEASING.md`, or one of the guides under `docs/`.

Fill in the pull request template so the reviewer can see what changed, how you
tested it, and whether a version bump was needed.

## Reporting bugs and asking for features

Use the [issue templates](https://github.com/TheSaltyKorean/md/issues/new/choose).
For a printing or PDF bug, attaching the source `.md` and, if you can, the
printed PDF makes it enormously faster to reproduce — redact anything private
first. **Never attach a real court filing with personal details in it.**

Security vulnerabilities go through [`SECURITY.md`](SECURITY.md), *not* the
public issue tracker.
94 changes: 94 additions & 0 deletions .github/ISSUE_TEMPLATE/bug_report.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,94 @@
name: 🐞 Bug report
description: Something in the app behaves incorrectly.
labels: ["bug"]
body:
- type: markdown
attributes:
value: |
Thanks for the report. Please check you're on the
[latest release](https://github.com/TheSaltyKorean/md/releases/latest)
first — the fix may already be shipped.

**Do not attach a real court filing or any document with personal
details in it.** Reduce it to a minimal example that still reproduces
the problem.

- type: input
id: version
attributes:
label: App version
description: Help → About shows it.
placeholder: "1.0.20"
validations:
required: true

- type: dropdown
id: platform
attributes:
label: Platform
options:
- Windows
- Linux
- Android
- macOS
- iOS
validations:
required: true

- type: input
id: os
attributes:
label: OS version and install method
description: How you installed it — MSI, setup.exe, portable zip, winget, .deb, tar.gz, APK.
placeholder: "Windows 11 24H2, installed via winget"

- type: dropdown
id: area
attributes:
label: Which part of the app?
options:
- Printing / PDF export
- Print & branding profiles
- Editor (WYSIWYG / Split / Raw / Preview)
- Opening or saving files
- Tabs, find & replace, or other editor UI
- Themes and appearance
- In-app updater
- Something else
validations:
required: true

- type: textarea
id: what-happened
attributes:
label: What happened
description: What you expected, and what you got instead.
validations:
required: true

- type: textarea
id: repro
attributes:
label: Steps to reproduce
placeholder: |
1. Open a document containing ...
2. Switch to Preview and choose the Court Filing profile
3. The heading renders as ...
validations:
required: true

- type: textarea
id: source
attributes:
label: Minimal Markdown that reproduces it
description: >
For a rendering or printing bug this is the single most useful thing you
can provide. Paste it here, or attach the `.md` file (and the printed
PDF if you have it) in the next box.
render: markdown

- type: textarea
id: extra
attributes:
label: Screenshots, PDFs, or anything else
description: Drag files in here. Redact anything private first.
10 changes: 10 additions & 0 deletions .github/ISSUE_TEMPLATE/config.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
# Questions and half-formed ideas have nowhere else to go while Discussions
# are off, so a blank issue stays available alongside the two templates.
blank_issues_enabled: true
contact_links:
- name: 🔒 Report a security vulnerability
url: https://github.com/TheSaltyKorean/md/security/advisories/new
about: Please report vulnerabilities privately, not in a public issue. See SECURITY.md.
- name: 📖 Documentation and guides
url: https://markdownstudio.dev/
about: Print profiles, inline HTML, AI profile authoring, and the roadmap.
46 changes: 46 additions & 0 deletions .github/ISSUE_TEMPLATE/feature_request.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,46 @@
name: ✨ Feature request
description: Suggest a capability or an improvement.
labels: ["enhancement"]
body:
- type: markdown
attributes:
value: |
Please skim [the roadmap](https://markdownstudio.dev/ROADMAP.html)
first — it may already be planned, or deliberately out of scope.

- type: textarea
id: problem
attributes:
label: What are you trying to do?
description: >
Describe the situation, not the solution. What are you writing, and
where does the app get in the way today?
validations:
required: true

- type: textarea
id: proposal
attributes:
label: What would you like it to do?
validations:
required: true

- type: dropdown
id: area
attributes:
label: Which part of the app?
options:
- Printing / PDF export
- Print & branding profiles
- Editor (WYSIWYG / Split / Raw / Preview)
- File handling
- Platform support / packaging
- Something else
validations:
required: true

- type: textarea
id: alternatives
attributes:
label: Workarounds you've tried
description: Including other tools — knowing what already works helps set the bar.
Loading
Loading