Contributing Guide

Create a CONTRIBUTING.md file for open-source projects.

freeworks offlinenothing uploaded
Input
Output

About contributing guide

Contributing Guide is a small tool that does one job while you watch. Nothing is saved, so a reload gives you a clean start.

Everything after the first page load is local. Pull the network cable mid-edit and the tool carries on as though nothing happened.

You will find it under Markdown, alongside 30 other tools for the same sort of job.

Includes sections for bug reporting, feature requests, pull requests, and code style guidelines.

How to use it

01
Start it
Every control is on the tool itself. Keyboard shortcuts, where there are any, are listed beside it.
02
Watch it run
It updates in the page as you go. Nothing is sent anywhere, so it keeps working with the network off.
03
Close when done
Nothing is stored between visits. Reloading gives you a clean start rather than picking up where you left off.

Examples

Generate a contributing guide
Create a CONTRIBUTING.md for an open-source project
Input
my-awesome-lib
Output
# Contributing to my-awesome-lib

Thank you for your interest in contributing to my-awesome-lib! This document provides guidelines and steps for contributing.

## Table of Contents

- [Reporting Bugs](#reporting-bugs)
- [Suggesting Features](#suggesting-features)
- [Pull Requests](#pull-requests)
- [Code Style](#code-style)

## Reporting Bugs

Before creating bug reports, please check the existing issues to avoid duplicates.

When creating a bug report, please include:

- **Clear title** describing the issue
- **Steps to reproduce** the behavior
- **Expected behavior** vs actual behavior
- **Environment details** (OS, Node version, etc.)
- **Screenshots** if applicable
- **Code samples** tha…

Questions

Does Contributing Guide work offline?+

Yes. It is JavaScript running in this tab, so once the page has loaded it needs nothing further from the network. Put the machine in flight mode and it carries on. Nothing you do here is sent anywhere, because there is nowhere for it to go.

Does it remember anything between visits?+

No. Reload the page and it starts from nothing. There is no account, no saved state and no cookie holding your last session. That is a deliberate trade: it cannot lose your data because it never keeps any.

Is it accurate?+

Timing comes from performance.now(), the high resolution clock the browser provides, rather than from setInterval, which drifts by a few milliseconds every tick and compounds over minutes. What can still shift things is the browser throttling a tab in the background, so leave it visible if the timing matters.

Does it make a sound?+

Where a sound makes sense, it is generated with the Web Audio API rather than loaded as a file, so there is nothing to download and nothing to block. Browsers refuse to start audio until you have interacted with the page, which is why the first press is what switches it on.

Can I use Contributing Guide on a phone?+

Yes. The controls are sized for touch and the layout collapses to one column on a narrow screen. Bear in mind that a phone locking its screen will suspend the page, and timing stops with it.