Free Markdown templates

# Project Name

One or two sentences that explain what this project does and who it is for.

Add a project screenshot when you have one:

<!-- ![Project screenshot](docs/images/screenshot.png) -->

## Table of Contents

- [Features](#features)
- [Installation](#installation)
- [Usage](#usage)
- [Configuration](#configuration)
- [Roadmap](#roadmap)
- [Contributing](#contributing)
- [License](#license)

## Features

- **Fast** — explain the main benefit in a few words
- **Simple** — another key capability
- **Extensible** — plugins, hooks, or an API

## Installation

```bash
git clone https://github.com/username/project-name.git
cd project-name
npm install
```

## Usage

```js
import { createThing } from 'project-name';

const thing = createThing({ verbose: true });
thing.run();
```

## Configuration

| Option    | Type      | Default | Description                  |
| --------- | --------- | ------- | ---------------------------- |
| `verbose` | `boolean` | `false` | Print detailed logs          |
| `timeout` | `number`  | `3000`  | Request timeout in ms        |
| `output`  | `string`  | `dist`  | Directory for generated files |

## Roadmap

- [x] Initial release
- [ ] Plugin system
- [ ] Documentation site

## Contributing

Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change. See [CONTRIBUTING.md](CONTRIBUTING.md) for details.

## License

[License name](LICENSE) — replace this with the license used by your project.

# Hi, I'm Your Name 👋

Software engineer who enjoys building developer tools and fast web apps.

## About me

- 🔭 Currently working on **Project X**
- 🌱 Learning **Rust** and **distributed systems**
- 💬 Ask me about **TypeScript, React, and Node.js**
- 📫 Reach me at **you@example.com**

## Tech stack

| Area      | Tools                          |
| --------- | ------------------------------ |
| Languages | TypeScript, Python, Go         |
| Frontend  | React, Next.js, Tailwind CSS   |
| Backend   | Node.js, PostgreSQL, Redis     |
| DevOps    | Docker, GitHub Actions, AWS    |

## Featured projects

- [**project-one**](https://github.com/username/project-one) — a short description of what it does
- [**project-two**](https://github.com/username/project-two) — a short description of what it does

## Connect

[Website](https://example.com) · [LinkedIn](https://linkedin.com/in/username) · [Blog](https://example.com/blog)

# Changelog

All notable changes to this project will be documented in this file.

The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/),
and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).

## [Unreleased]

### Added

- New feature that is not released yet

## [1.1.0] - 2026-10-01

### Added

- Export to PDF
- Dark mode support

### Changed

- Improved startup time by lazy-loading plugins

### Fixed

- Crash when the config file is empty

## [1.0.0] - 2026-08-15

### Added

- Initial release

[Unreleased]: https://github.com/username/project/compare/v1.1.0...HEAD
[1.1.0]: https://github.com/username/project/compare/v1.0.0...v1.1.0
[1.0.0]: https://github.com/username/project/releases/tag/v1.0.0

# Contributing to Project Name

Thanks for taking the time to contribute! This guide explains how to set up the project and submit changes.

## Code of conduct

By participating, you agree to follow our [Code of Conduct](CODE_OF_CONDUCT.md).

## Getting started

1. Fork the repository and clone your fork.
2. Install dependencies:

   ```bash
   npm install
   ```

3. Create a branch for your change:

   ```bash
   git checkout -b feat/short-description
   ```

## Development workflow

| Command         | What it does               |
| --------------- | -------------------------- |
| `npm run dev`   | Start the dev server       |
| `npm test`      | Run the test suite         |
| `npm run lint`  | Check formatting and lint  |

## Commit messages

We use [Conventional Commits](https://www.conventionalcommits.org/en/v1.0.0/):

```text
feat: add CSV export
fix: handle empty config file
docs: clarify installation steps
```

## Pull requests

- [ ] Tests pass locally
- [ ] New behavior is covered by tests
- [ ] Documentation is updated
- [ ] The PR description explains **what** changed and **why**

## Reporting bugs

Open an issue with steps to reproduce, the expected result, and the actual result. Screenshots and logs help a lot.

---
name: Bug report
about: Report something that is not working as expected
title: "[Bug]: "
labels: bug
assignees: ''
---

## Description

A clear and concise description of the bug.

## Steps to reproduce

1. Go to '...'
2. Click on '...'
3. Scroll down to '...'
4. See the error

## Expected behavior

What you expected to happen.

## Actual behavior

What actually happened. Include error messages if any.

```text
Paste logs or stack traces here
```

## Screenshots

If applicable, add screenshots to help explain the problem.

## Environment

| Item     | Value              |
| -------- | ------------------ |
| OS       | e.g. macOS 15      |
| Browser  | e.g. Chrome 130    |
| Version  | e.g. 1.2.3         |

## Additional context

Anything else that might help us understand the issue.

## Summary

Briefly describe what this pull request changes and why.

Closes #123

## Type of change

- [ ] Bug fix
- [ ] New feature
- [ ] Breaking change
- [ ] Documentation
- [ ] Refactor / chore

## How was this tested?

Describe the tests you ran and how reviewers can reproduce them.

```bash
npm test
```

## Screenshots

| Before | After |
| ------ | ----- |
| [Attach a screenshot of the previous behavior] | [Attach a screenshot of the updated behavior] |

## Checklist

- [ ] My code follows the project style guidelines
- [ ] I have added tests that prove my fix or feature works
- [ ] I have updated the documentation
- [ ] New and existing tests pass locally

# Security Policy

## Maintained releases

Replace the example rows with your actual support policy.

| Release | Receives security fixes? |
| --- | --- |
| Current stable | Yes |
| Earlier releases | Describe your policy |

## Send a private report

Contact: [security contact](mailto:security@example.com)

Please avoid publishing sensitive details in a public issue. Include:

- Affected release and component
- Reproduction instructions and a minimal example
- Potential impact and any relevant logs, with secrets removed

## What happens next

- Acknowledgment target: [choose a realistic interval]
- Follow-up channel: [email or private advisory]
- Coordinated publication: [describe how you agree on disclosure]

For general usage questions, use the project's normal support channel.

---
name: Feature request
about: Suggest an improvement with a concrete use case
title: "[Feature]: "
labels: enhancement
assignees: ''
---

## Who needs this?

Describe the person or team and the task they are trying to finish.

## Current limitation

Explain what happens today and why the existing workflow is difficult.

## Requested behavior

Describe the result you want. Include an example input and expected output when useful.

## Other approaches

What workarounds or alternative solutions have you considered?

## Evidence and scope

Link related issues or examples. Separate essential behavior from optional enhancements.

## Completion checks

- [ ] The new workflow addresses the original problem
- [ ] Existing behavior remains documented
- [ ] Examples or screenshots are included where relevant

# Release [version]

- **Published:** [date]
- **Previous version:** [version]

## At a glance

Explain the main reason a user would install this release.

## Changes in this release

- **New:** [user-visible capability] — [pull request](https://github.com/owner/repo/pull/1)
- **Improved:** [existing workflow and its benefit]
- **Resolved:** [symptom that no longer occurs]

## Before updating

List compatibility changes, required configuration updates, or migration instructions. Write “No migration required” only after checking.

## Contributors

Thank the people whose work shipped in this release, including first-time contributors.

## Compare versions

[All changes](https://github.com/owner/repo/compare/previous...current)

## Remaining limitations

List known issues with a workaround or tracking link.

# API Reference

Base URL: `https://api.example.com/v1`

## Authentication

Send your API key in the `Authorization` header:

```http
Authorization: Bearer YOUR_API_KEY
```

## List users

```http
GET /users
```

### Query parameters

| Name    | Type     | Required | Description                         |
| ------- | -------- | :------: | ----------------------------------- |
| `page`  | integer  |    No    | Page number, starting at 1          |
| `limit` | integer  |    No    | Results per page (max 100)          |
| `role`  | string   |    No    | Filter by role: `admin` or `member` |

### Example request

```bash
curl -H "Authorization: Bearer YOUR_API_KEY" \
  "https://api.example.com/v1/users?page=1&limit=20"
```

### Example response

```json
{
  "data": [
    { "id": 42, "name": "Ada Lovelace", "role": "admin" }
  ],
  "page": 1,
  "total": 1
}
```

## Errors

| Status | Code              | Meaning                          |
| :----: | ----------------- | -------------------------------- |
|  400   | `invalid_request` | A parameter is missing or wrong  |
|  401   | `unauthorized`    | The API key is missing or invalid |
|  429   | `rate_limited`    | Too many requests; retry later   |

> **Note:** All timestamps are returned in ISO 8601 format (UTC).

# RFC: Title of the Proposal

| Field   | Value            |
| ------- | ---------------- |
| Author  | Your Name        |
| Status  | Draft            |
| Created | 2026-10-22       |
| Reviewers | @alice, @bob   |

## Context

What problem are we solving, and why now? Link to related issues or incidents.

## Goals

- Goal one
- Goal two

## Non-goals

- What this proposal intentionally does not cover

## Proposed design

Describe the solution. Diagrams help reviewers understand the flow.

```mermaid
flowchart LR
  Client --> API[API Gateway]
  API --> Service[Order Service]
  Service --> DB[(Database)]
  Service --> Queue[[Event Queue]]
```

### Data model

```sql
CREATE TABLE orders (
  id BIGSERIAL PRIMARY KEY,
  user_id BIGINT NOT NULL,
  status TEXT NOT NULL,
  created_at TIMESTAMPTZ DEFAULT now()
);
```

## Alternatives considered

| Option        | Pros            | Cons                    |
| ------------- | --------------- | ----------------------- |
| Option A      | Simple          | Does not scale          |
| Option B      | Scales well     | More moving parts       |

## Rollout plan

1. Ship behind a feature flag
2. Enable for 5% of traffic
3. Monitor error rate and latency
4. Roll out to 100%

## Open questions

- [ ] How do we migrate existing data?
- [ ] Who owns on-call for the new service?

---
title: "Article title"
description: "A short summary that shows up in search results and social previews."
date: 2026-10-22
author: Your Name
tags: [engineering, performance]
cover: /images/cover.png
draft: false
---

# Article title

Open with a hook: the problem, a surprising number, or a question your reader is asking.

## The problem

Explain the situation and why it mattered. Keep paragraphs short.

## What we tried

1. **First attempt** — what happened
2. **Second attempt** — what we learned
3. **The fix** — what finally worked

```yaml
# A small, relevant snippet
cache:
  paths:
    - node_modules/
```

## Results

Replace these placeholders with measured results.

| Metric        | Before | After |
| ------------- | -----: | ----: |
| Build time    | [before] | [after] |
| Cache hit rate | [before] | [after] |

> [Add a short quotation or key finding, with attribution where needed.]

## Key takeaways

- Takeaway one
- Takeaway two
- Takeaway three

*Have questions? [Get in touch](mailto:you@example.com).*

# ADR 0001: [Decision title]

- **State:** Proposed
- **Recorded:** [date]
- **Participants:** [names]

## Problem to resolve

Describe the architectural question, constraints, and relevant evidence. Link the related design discussion.

## Selection criteria

- [Important quality or constraint]
- [Operational or maintenance requirement]

## Alternatives evaluated

| Approach | Benefit | Cost or limitation |
| --- | --- | --- |
| A | [benefit] | [tradeoff] |
| B | [benefit] | [tradeoff] |

## Chosen approach

We choose [approach] because [reason linked to the criteria].

## Expected effects

- Benefits we expect:
- Costs and risks we accept:

## Validation and review

How will we verify the decision works? Record a review date and link any later ADR that replaces this one.

# Product Requirements: [Feature]

- **Owner:** [name]
- **Stage:** Draft
- **Target release:** [date]
- **Design and tracking links:** [links]

## User problem

Who is affected, what are they trying to accomplish, and what evidence supports this need?

## Intended outcome

| Outcome | Metric | Success threshold |
| --- | --- | --- |
| [benefit] | [measurement] | [target] |

## Assumptions to verify

- [Assumption and how to test it]

## User scenarios and requirements

| Scenario | Required behavior | Priority |
| --- | --- | --- |
| [user task] | [observable result] | Must have |

## Experience

Link sketches and describe the primary flow, errors, and empty states.

## Boundaries and open questions

- Excluded from this release:
- Decisions still needed:

## Release checks

- [ ] Requirements reviewed
- [ ] Metrics can be measured
- [ ] Outstanding questions have owners

# Incident Review: [Short title]

- **Incident:** [tracking link]
- **Date:** [date]
- **Author:** [name]
- **Review state:** Draft

## Overview and impact

Summarize the failure. Describe affected users, services, and duration using verified evidence.

## Detection and recovery

- How we first noticed:
- Immediate mitigation:
- How we confirmed recovery:

## Event log

Use a single timezone throughout.

| Time | Observation or action | Evidence |
| --- | --- | --- |
| [time] | [event] | [dashboard or log] |

## Contributing conditions

Explain the trigger and system conditions that allowed the incident. Focus on mechanisms rather than individual blame.

## Lessons

- Practices that helped:
- Gaps in detection or response:

## Follow-up work

| Action | Owner | Due date | Tracking link |
| --- | --- | --- | --- |
| [prevent or reduce recurrence] | [name] | [date] | [issue] |

# Runbook: [Operational task]

- **Maintainer:** [team]
- **Last rehearsal:** [date]
- **Expected result:** [observable outcome]

## When to use

Describe the task and conditions under which this procedure applies.

## Preparation

- Required tools and access:
- Target service and environment:
- Approved execution window:
- Relevant dashboards and documentation:

## Procedure

| Step | Instruction | Expected observation |
| --- | --- | --- |
| 1 | Confirm the target environment | [evidence] |
| 2 | Follow the reviewed task instructions | [evidence] |
| 3 | Check the result | [evidence] |

## If a step fails

Stop at [defined condition]. Record the failed step and its output. Follow the reviewed recovery procedure at [link], or contact [on-call channel].

## Completion

- [ ] Expected result verified
- [ ] Work recorded in the change log
- [ ] Documentation updated if the procedure changed

# Meeting Notes: Project Sync

- **Date:** 2026-10-22
- **Time:** 10:00–10:45
- **Facilitator:** Name
- **Note taker:** Name

## Attendees

- Alice (Product)
- Bob (Engineering)
- Carol (Design)

## Agenda

1. Review last week's action items
2. Q4 roadmap priorities
3. Open questions

## Discussion

### 1. Last week's action items

- Onboarding flow is shipped; early metrics look positive
- API migration is 70% complete

### 2. Q4 roadmap priorities

- Agreed to focus on performance before new features
- Design will share mockups for the settings page

## Decisions

> **Decision:** Freeze new feature work until the performance goals are met.

## Action items

- [ ] @bob — Finish the API migration (due Oct 29)
- [ ] @carol — Share settings page mockups (due Oct 25)
- [ ] @alice — Update the roadmap doc (due Oct 24)

## Next meeting

2026-10-29, same time.

---
date: 2026-10-22
tags: [daily]
mood:
---

# Thursday, October 22, 2026

## Top 3 priorities

1. [First priority]
2. [Second priority]
3. [Third priority]

## Schedule

| Time  | Plan                 |
| ----- | -------------------- |
| 09:00 | Deep work            |
| 12:00 | Lunch                |
| 14:00 | Meetings             |
| 16:00 | Email and admin      |

## Tasks

- [ ] [First task]
- [ ] [Second task]
- [ ] [Third task]

## Notes

- [Observation, idea, or link]

## Reflection

**What went well?**

**What could be better tomorrow?**

**Grateful for:**

# Weekly Report — Week 43, 2026

- **Team:** Platform
- **Author:** Your Name
- **Period:** Oct 19 – Oct 23

## TL;DR

Shipped the new onboarding flow; the API migration is on track; one blocker on vendor access.

## Highlights

- 🚀 Released onboarding v2 to all users
- 📈 Sign-up conversion up from 18% to 23%
- 🧪 Test coverage reached 85%

## Progress

| Goal               | Status         | Notes                     |
| ------------------ | -------------- | ------------------------- |
| Onboarding v2      | ✅ Done        | Shipped Tuesday           |
| API migration      | 🟡 In progress | 70% of endpoints moved    |
| Billing redesign   | 🔴 Blocked     | Waiting on vendor access  |

## Blockers

- **Vendor access** — need admin credentials from the finance team

## Next week

- [ ] Finish the API migration
- [ ] Start billing redesign once unblocked
- [ ] Write the onboarding retrospective

# Project Plan: Website Redesign

## Overview

Redesign the marketing site to improve conversion and page speed.

## Goals & success metrics

| Goal              | Metric                 | Target  |
| ----------------- | ---------------------- | ------- |
| Faster pages      | Largest Contentful Paint | < 2.0 s |
| More sign-ups     | Visitor → sign-up rate | +20%    |

## Scope

- **In scope:** home page, pricing, docs landing
- **Out of scope:** blog, app dashboard

## Timeline

```mermaid
gantt
  title Website Redesign
  dateFormat YYYY-MM-DD
  section Discovery
  Research & interviews :done, d1, 2026-10-01, 10d
  section Design
  Wireframes            :active, d2, after d1, 7d
  Visual design         :d3, after d2, 10d
  section Build
  Development           :d4, after d3, 14d
  QA & launch           :d5, after d4, 5d
```

## Team

| Role        | Owner  |
| ----------- | ------ |
| Project lead | Alice |
| Design      | Carol  |
| Engineering | Bob    |

## Risks

| Risk                    | Impact | Mitigation              |
| ----------------------- | :----: | ----------------------- |
| Content not ready       |  High  | Start copywriting early |
| Scope creep             | Medium | Weekly scope review     |

# Retrospective: [Sprint or project]

- **Period:** [dates]
- **Facilitator:** [name]
- **Participants:** [names]

## Previous experiments

Review the improvements agreed last time. Did they have the intended effect?

## What helped us?

- [Observation with a concrete example]

## What made work harder?

- [Observation and its effect on the team]

## What did we learn?

- [New understanding to carry forward]

## Themes to discuss

Group related observations. Choose a few issues the team can influence rather than trying to fix everything at once.

## Next experiments

| Improvement | Owner | Check-in date | Evidence of progress |
| --- | --- | --- | --- |
| [small change to try] | [name] | [date] | [measurement] |

## Follow-up

Link the agreed actions and revisit them at the next retrospective.

# One-on-one: [Names]

- **Cadence:** [schedule]
- **Shared agenda:** [document link]

Keep this as a rolling agenda. Add topics between meetings and review recent additions first within each section.

## Career and growth

- [Skill, opportunity, or training to discuss]
- [Feedback you want to request or offer]

## Longer-term direction

- [Where you want your role or team to develop]
- [Practice worth sharing]

## Current discussion

- **DISCUSS — [date], [name]:** [topic and context]
- **HELP — [date], [name]:** [blocker and support needed]
- **THANKS — [date], [name]:** [specific contribution to recognize]

## Agreed follow-ups

- [ ] [Owner] — [next step], by [date]

Mark completed topics and remove them after both participants have seen the outcome. Keep sensitive notes in an appropriately restricted location.

# Your Name

**[Professional title]**

- **Location:** [City, Country]
- **Email:** [you@example.com](mailto:you@example.com)
- **LinkedIn:** [linkedin.com/in/you](https://linkedin.com/in/you)
- **GitHub:** [github.com/you](https://github.com/you)

## Summary

[Describe your relevant experience, main strengths, and the kind of role you are seeking in two or three sentences.]

## Experience

### [Job title] — [Company]

*[Start date] – [End date or Present] · [Location or Remote]*

- [Describe a contribution, your specific role, and the observed outcome.]
- [Include a verified metric or concrete example where available.]
- [Describe collaboration, leadership, or a problem you helped resolve.]

### [Previous job title] — [Company]

*[Start date] – [End date] · [Location]*

- [Describe a relevant contribution and its result.]
- [Explain the scope of your responsibilities.]

## Projects

### [Project name](https://example.com)

[Explain what the project does, your contribution, and the technologies used. Link to work you can share.]

## Skills

- **Languages:** [Relevant programming or spoken languages]
- **Tools and frameworks:** [Tools you have used in practice]
- **Other strengths:** [Relevant methods or domain knowledge]

## Education

**[Degree or qualification]** — [Institution]

[Graduation date or period of study]

# Accomplishments: [Name and period]

## Goals

- [Outcome you are working toward]

## Project contributions

### [Project]

- My contribution:
- Who benefited:
- Observed result, with evidence:
- Links to work or feedback:
- Follow-up result to check later:

## Helping others succeed

Record mentoring, collaboration, reviews, or shared work that made someone else's task easier.

- [Contribution, beneficiary, and evidence]

## Design and knowledge sharing

- [Document, talk, or design work and the problem it helped solve]

## Improvements beyond projects

- [Process or team improvement and its effect]

## Learning

- [Skill practiced and where you applied it]

## Next period

- [Goal or opportunity to discuss]

Update this record regularly. Use verified outcomes and specific examples rather than inflated claims.