chore: add community standard files (#27)

andrinoff · web-flow · commit bb5023bbc8db · 2026-03-17T10:20:06.000+04:00
diff --git a/.github/ISSUE_TEMPLATE/bug_report.yml b/.github/ISSUE_TEMPLATE/bug_report.yml
@@ -0,0 +1,71 @@
+name: Bug Report
+description: Create a report to help us improve
+title: "BUG: "
+labels: ["bug", "needs-triage"]
+body:
+  - type: textarea
+    id: description
+    attributes:
+      label: Describe the bug
+      description: A clear and concise description of what the bug is.
+    validations:
+      required: true
+
+  - type: textarea
+    id: reproduce
+    attributes:
+      label: To reproduce
+      description: Steps to reproduce the behavior.
+      placeholder: |
+        1. Go to '...'
+        2. Click on '...'
+        3. See error
+    validations:
+      required: true
+
+  - type: textarea
+    id: expected
+    attributes:
+      label: Expected behavior
+      description: A clear and concise description of what you expected to happen.
+    validations:
+      required: true
+
+  - type: textarea
+    id: screenshots
+    attributes:
+      label: Screenshots
+      description: If applicable, add screenshots to help explain your problem.
+
+  - type: input
+    id: matcha-version
+    attributes:
+      label: Matcha version
+      placeholder: "e.g. 0.20.0"
+
+  - type: input
+    id: go-version
+    attributes:
+      label: Go version
+      description: "Run `go version` to find out. Only relevant if the issue is related to Go/compilation."
+      placeholder: "e.g. 1.22.0"
+
+  - type: input
+    id: os
+    attributes:
+      label: OS
+      placeholder: "e.g. macOS 14, Ubuntu 24.04, Windows 11"
+    validations:
+      required: true
+
+  - type: input
+    id: terminal
+    attributes:
+      label: Terminal
+      placeholder: "e.g. iTerm2, Windows Terminal, Alacritty"
+
+  - type: textarea
+    id: additional
+    attributes:
+      label: Additional context
+      description: Add any other context about the problem here.
diff --git a/.github/ISSUE_TEMPLATE/feature_request.yml b/.github/ISSUE_TEMPLATE/feature_request.yml
@@ -0,0 +1,31 @@
+name: Feature Request
+description: Suggest an idea for this project
+title: "FEAT: "
+labels: ["enhancement", "needs-triage"]
+body:
+  - type: textarea
+    id: problem
+    attributes:
+      label: Is your feature request related to a problem?
+      description: A clear and concise description of what the problem is.
+      placeholder: "I'm always frustrated when..."
+
+  - type: textarea
+    id: solution
+    attributes:
+      label: Describe the solution you'd like
+      description: A clear and concise description of what you want to happen.
+    validations:
+      required: true
+
+  - type: textarea
+    id: alternatives
+    attributes:
+      label: Describe alternatives you've considered
+      description: A clear and concise description of any alternative solutions or features you've considered.
+
+  - type: textarea
+    id: additional
+    attributes:
+      label: Additional context
+      description: Add any other context or screenshots about the feature request here.
diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md
@@ -0,0 +1,7 @@
+## What?
+
+<!-- Describe what this PR changes. Keep it concise — what code was added, removed, or modified? -->
+
+## Why?
+
+<!-- Explain the motivation behind this change. What problem does it solve, or what addition does it enable? Link related issues if applicable. -->
diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml
@@ -56,6 +56,7 @@ jobs:
     permissions:
       contents: read
       pull-requests: write
+      issues: write
     steps:
       - uses: actions/checkout@v6
 
diff --git a/CODE_OF_CONDUCT.md b/CODE_OF_CONDUCT.md
@@ -0,0 +1,78 @@
+Contributor Covenant 3.0 Code of Conduct
+Our Pledge
+
+We pledge to make our community welcoming, safe, and equitable for all.
+
+We are committed to fostering an environment that respects and promotes the dignity, rights, and contributions of all individuals, regardless of characteristics including race, ethnicity, caste, color, age, physical characteristics, neurodiversity, disability, sex or gender, gender identity or expression, sexual orientation, language, philosophy or religion, national or social origin, socio-economic position, level of education, or other status. The same privileges of participation are extended to everyone who participates in good faith and in accordance with this Covenant.
+Encouraged Behaviors
+
+While acknowledging differences in social norms, we all strive to meet our community's expectations for positive behavior. We also understand that our words and actions may be interpreted differently than we intend based on culture, background, or native language.
+
+With these considerations in mind, we agree to behave mindfully toward each other and act in ways that center our shared values, including:
+
+    Respecting the purpose of our community, our activities, and our ways of gathering.
+    Engaging kindly and honestly with others.
+    Respecting different viewpoints and experiences.
+    Taking responsibility for our actions and contributions.
+    Gracefully giving and accepting constructive feedback.
+    Committing to repairing harm when it occurs.
+    Behaving in other ways that promote and sustain the well-being of our community.
+
+Restricted Behaviors
+
+We agree to restrict the following behaviors in our community. Instances, threats, and promotion of these behaviors are violations of this Code of Conduct.
+
+    Harassment. Violating explicitly expressed boundaries or engaging in unnecessary personal attention after any clear request to stop.
+    Character attacks. Making insulting, demeaning, or pejorative comments directed at a community member or group of people.
+    Stereotyping or discrimination. Characterizing anyone’s personality or behavior on the basis of immutable identities or traits.
+    Sexualization. Behaving in a way that would generally be considered inappropriately intimate in the context or purpose of the community.
+    Violating confidentiality. Sharing or acting on someone's personal or private information without their permission.
+    Endangerment. Causing, encouraging, or threatening violence or other harm toward any person or group.
+    Behaving in other ways that threaten the well-being of our community.
+
+Other Restrictions
+
+    Misleading identity. Impersonating someone else for any reason, or pretending to be someone else to evade enforcement actions.
+    Failing to credit sources. Not properly crediting the sources of content you contribute.
+    Promotional materials. Sharing marketing or other commercial content in a way that is outside the norms of the community.
+    Irresponsible communication. Failing to responsibly present content which includes, links or describes any other restricted behaviors.
+
+Reporting an Issue
+
+Tensions can occur between community members even when they are trying their best to collaborate. Not every conflict represents a code of conduct violation, and this Code of Conduct reinforces encouraged behaviors and norms that can help avoid conflicts and minimize harm.
+
+When an incident does occur, it is important to report it promptly. To report a possible violation, please email [us@floatpane.com](mailto:us@floatpane.com). All reports will be handled with discretion and confidentiality.
+
+Community Moderators take reports of violations seriously and will make every effort to respond in a timely manner. They will investigate all reports of code of conduct violations, reviewing messages, logs, and recordings, or interviewing witnesses and other participants. Community Moderators will keep investigation and enforcement actions as transparent as possible while prioritizing safety and confidentiality. In order to honor these values, enforcement actions are carried out in private with the involved parties, but communicating to the whole community may be part of a mutually agreed upon resolution.
+Addressing and Repairing Harm
+
+If an investigation by the Community Moderators finds that this Code of Conduct has been violated, the following enforcement ladder may be used to determine how best to repair harm, based on the incident's impact on the individuals involved and the community as a whole. Depending on the severity of a violation, lower rungs on the ladder may be skipped.
+
+    Warning
+        Event: A violation involving a single incident or series of incidents.
+        Consequence: A private, written warning from the Community Moderators.
+        Repair: Examples of repair include a private written apology, acknowledgement of responsibility, and seeking clarification on expectations.
+    Temporarily Limited Activities
+        Event: A repeated incidence of a violation that previously resulted in a warning, or the first incidence of a more serious violation.
+        Consequence: A private, written warning with a time-limited cooldown period designed to underscore the seriousness of the situation and give the community members involved time to process the incident. The cooldown period may be limited to particular communication channels or interactions with particular community members.
+        Repair: Examples of repair may include making an apology, using the cooldown period to reflect on actions and impact, and being thoughtful about re-entering community spaces after the period is over.
+    Temporary Suspension
+        Event: A pattern of repeated violation which the Community Moderators have tried to address with warnings, or a single serious violation.
+        Consequence: A private written warning with conditions for return from suspension. In general, temporary suspensions give the person being suspended time to reflect upon their behavior and possible corrective actions.
+        Repair: Examples of repair include respecting the spirit of the suspension, meeting the specified conditions for return, and being thoughtful about how to reintegrate with the community when the suspension is lifted.
+    Permanent Ban
+        Event: A pattern of repeated code of conduct violations that other steps on the ladder have failed to resolve, or a violation so serious that the Community Moderators determine there is no way to keep the community safe with this person as a member.
+        Consequence: Access to all community spaces, tools, and communication channels is removed. In general, permanent bans should be rarely used, should have strong reasoning behind them, and should only be resorted to if working through other remedies has failed to change the behavior.
+        Repair: There is no possible repair in cases of this severity.
+
+This enforcement ladder is intended as a guideline. It does not limit the ability of Community Managers to use their discretion and judgment, in keeping with the best interests of our community.
+Scope
+
+This Code of Conduct applies within all community spaces, and also applies when an individual is officially representing the community in public or other spaces. Examples of representing our community include using an official email address, posting via an official social media account, or acting as an appointed representative at an online or offline event.
+Attribution
+
+This Code of Conduct is adapted from the Contributor Covenant, version 3.0, permanently available at https://www.contributor-covenant.org/version/3/0/.
+
+Contributor Covenant is stewarded by the Organization for Ethical Source and licensed under CC BY-SA 4.0. To view a copy of this license, visit https://creativecommons.org/licenses/by-sa/4.0/
+
+For answers to common questions about Contributor Covenant, see the FAQ at https://www.contributor-covenant.org/faq. Translations are provided at https://www.contributor-covenant.org/translations. Additional enforcement and community guideline resources can be found at https://www.contributor-covenant.org/resources. The enforcement ladder was inspired by the work of Mozilla’s code of conduct team.
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -0,0 +1,111 @@
+# Contributing to Lattice
+
+Thank you for your interest in contributing to Lattice! This guide will help you get started.
+
+## Getting Started
+
+### Prerequisites
+
+- [Go 1.26+](https://go.dev/dl/)
+- A terminal emulator with modern capabilities (kitty, ghostty, alacritty, etc.)
+- An IMAP email account for testing
+
+### Setup
+
+```bash
+git clone https://github.com/floatpane/lattice.git
+cd matcha
+go mod tidy
+```
+
+### Build & Run
+
+```bash
+make build     # builds to ./lattice
+make run       # builds and runs in one step
+```
+
+### Testing
+
+```bash
+make test              # run all tests
+make test-verbose      # run tests with verbose output
+make test-coverage     # run tests and generate a coverage report
+```
+
+### Linting
+
+```bash
+make lint       # runs go fmt and go vet
+```
+
+## Making Changes
+
+### Branch Naming
+
+Create a branch from `master` using one of these prefixes:
+
+- `feature/` — new functionality
+- `fix/` — bug fixes
+- `docs/` — documentation changes
+- `refactor/` — code restructuring without behavior changes
+
+### Commit Messages
+
+We use [Conventional Commits](https://www.conventionalcommits.org/). Format your commit messages as:
+
+```
+type(scope): short description
+```
+
+Common types: `feat`, `fix`, `docs`, `test`, `ci`, `chore`.
+
+Examples:
+```
+feat(compose): add CC/BCC field support
+fix(imap): handle connection timeout gracefully
+docs: update installation instructions
+```
+
+### Before Submitting a PR
+
+1. Run `make lint` and fix any issues.
+2. Run `make test` and make sure all tests pass.
+3. Keep your PR focused — one logical change per PR.
+4. Write a clear PR description explaining **what** changed and **why**.
+
+## Reporting Bugs
+
+Open an issue using the [bug report template](https://github.com/floatpane/lattice/issues/new?template=bug_report.md). Include:
+
+- Steps to reproduce the issue
+- Expected vs. actual behavior
+- Your OS, terminal emulator, and Lattice version
+
+## Requesting Features
+
+Open an issue using the [feature request template](https://github.com/floatpane/lattice/issues/new?template=feature_request.md) with a clear description of the problem you're trying to solve and your proposed solution.
+
+## AI Policy
+
+We welcome contributions that use AI-assisted tools (Copilot, Claude, ChatGPT, etc.) as part of the development process. That said, contributors are fully responsible for any code they submit, regardless of how it was written.
+
+**What we expect:**
+
+- **Understand what you submit.** You should be able to explain every line of your PR. If you can't explain it, don't submit it.
+- **Review AI output carefully.** AI tools can produce plausible-looking code that is subtly wrong, insecure, or doesn't match the project's patterns. Treat AI suggestions the same way you'd treat a Stack Overflow snippet — verify before committing.
+- **Don't submit AI-generated issues, reviews, or comments.** Discussions should be genuine human communication. Using AI to help draft something is fine, but don't paste raw AI output into issues or review comments.
+- **No AI-generated tests that don't actually test anything.** Tests must be meaningful and actually validate behavior, not just exist for coverage numbers.
+- **Attribute when appropriate.** If a significant portion of your contribution was AI-assisted, a brief mention in your PR description is appreciated but not required.
+
+**What we won't accept:**
+
+- Bulk PRs of AI-generated refactors, documentation, or "improvements" that weren't requested.
+- Code that introduces hallucinated dependencies, APIs, or patterns that don't exist in the project.
+- Contributions where the author clearly doesn't understand the changes they're proposing.
+
+The goal is simple: AI is a tool. Use it well, take ownership of the output, and make sure your contribution actually improves the project.
+
+## Code of Conduct
+
+This project follows the [Contributor Covenant Code of Conduct](CODE_OF_CONDUCT.md). By participating, you agree to uphold a welcoming and respectful environment for everyone.
diff --git a/Makefile b/Makefile
@@ -0,0 +1,43 @@
+.PHONY: build test run clean lint fmt vet build-full generate_screenshots
+
+BINARY_NAME=lattice
+
+build:
+	go build -o $(BINARY_NAME) .
+
+build-full:
+	@echo "Building with version information..."
+	@VERSION=$$(git describe --tags --abbrev=0 2>/dev/null || echo "dev"); \
+	COMMIT=$$(git rev-parse --short HEAD 2>/dev/null || echo "unknown"); \
+	DATE=$$(date +%Y-%m-%d); \
+	echo "Version: $$VERSION"; \
+	echo "Commit: $$COMMIT"; \
+	echo "Date: $$DATE"; \
+	go build -ldflags="-X 'main.version=$$VERSION' -X 'main.commit=$$COMMIT' -X 'main.date=$$DATE'" -o $(BINARY_NAME)-full .;
+
+run:
+	go run .
+
+test:
+	go test ./...
+
+test-verbose:
+	go test -v ./...
+
+test-coverage:
+	go test -coverprofile=coverage.out ./...
+	go tool cover -html=coverage.out -o coverage.html
+
+clean:
+	rm -rf $(BUILD_DIR)
+	rm -f coverage.out coverage.html
+
+fmt:
+	go fmt ./...
+
+vet:
+	go vet ./...
+
+lint: fmt vet
+
+all: lint test build
diff --git a/SECURITY.md b/SECURITY.md
@@ -0,0 +1,26 @@
+# Security Policy
+
+## Supported Versions
+
+Only the latest release of Lattice is supported with security updates.
+
+## Reporting a Vulnerability
+
+If you discover a security vulnerability in Matcha, please report it responsibly. **Do not open a public issue.**
+
+Email us at [us@floatpane.com](mailto:us@floatpane.com) with:
+
+- A description of the vulnerability
+- Steps to reproduce the issue
+- The potential impact
+- Any suggested fixes (optional)
+
+We will acknowledge your report within 48 hours and aim to provide a fix or mitigation plan within 7 days, depending on severity.
+
+## Scope
+
+This policy covers the Matcha codebase and its official releases. Third-party dependencies are outside our direct control, but we will work to address reported issues in dependencies as quickly as possible.
+
+## Disclosure
+
+We ask that you give us reasonable time to address the issue before disclosing it publicly. We are committed to crediting reporters in release notes (unless you prefer to remain anonymous).
