Build contributing guide documents with sections for setup, coding standards, and PR process.
CONTRIBUTING.md Generator assembles a draft contribution guide for a software repository. It organizes project instructions into sections covering local setup, coding standards, and the pull request process, giving prospective contributors a single document to consult before proposing changes. The result is documentation rather than repository configuration or workflow automation. The most common mistake is publishing the draft without verifying project-specific details. Installation commands, test commands, branch conventions, formatting rules, and review expectations must match the repository as it actually operates.
The generator builds the guide around three contributor-facing areas: preparing a local development environment, following the project's coding conventions, and submitting changes for review. These sections collectively address what a contributor should do before editing code, while making changes, and before or after opening a pull request.
The resulting content is intended for a file named CONTRIBUTING.md. On GitHub, this file can be surfaced when someone opens an issue or pull request. It remains advisory text: maintainers should review it before committing it, and repository automation must separately implement any required tests, formatting checks, approvals, or branch protections.
No. The document tells contributors what the project expects, but it does not enforce those expectations. Enforcement requires separate repository configuration, such as formatter settings, lint rules, test workflows, required status checks, review requirements, or branch protection. Keep the written guide synchronized with those controls so contributors do not receive conflicting instructions.
Usually not in full. The README can introduce the project and provide the normal user-facing setup path, while CONTRIBUTING.md should focus on the additional steps needed to modify and submit code. It can point to the README where appropriate, then document contributor-specific commands, validation steps, coding conventions, commit expectations, and the pull request review process.
The behavioral notes were checked against the browser implementation. Standards and primary references below define the relevant format, formula, or platform behavior.
Format, validate, and beautify JSON with syntax highlighting and error detection.
Encode text or files to Base64 and decode Base64 strings back to their original form.
Format and indent SQL queries for better readability across all major dialects.
Convert HTML markup into clean Markdown syntax with support for tables and lists.
Write Markdown and see the rendered HTML output in real time with live preview.
Visualize unified diffs and patch files with color-coded additions and deletions.