Skip to content

Open source

Contributing

How to report a bug, suggest an idea, or send a pull request.

goclean is MIT licensed and developed in the open. Bug reports, fixes, documentation improvements and ideas are all welcome.

Where to start

Everything happens in the goclean repository on GitHub. Open issues and pull requests there, whether they concern the CLI, the documentation or this website.

Reporting a bug

Open an issue and include:

  • The exact command you ran, with flags, and the output.
  • Your goclean version (goclean version) and operating system.
  • The result of goclean doctor.
  • What you expected to happen instead.

Check Troubleshooting and existing issues first.

Suggesting a feature

Open an issue describing the problem you want solved before writing code. A short discussion up front saves rework, especially for changes to generated project structure.

Working on the website

Clone the repository, then use Node.js 22 or newer, matching the deploy workflow, from the website's directory.

bash
npm install
npm run dev

The dev server runs at http://localhost:5173. Before you open a pull request, run:

bash
npm run lint
npm run build

npm run build type-checks the project, builds it, and prerenders every route to static HTML, so it catches most mistakes.

Where things live

  • src/docs/pages.tsx — the documentation pages.
  • src/pages — Home, About, FAQ, Changelog and the other pages.
  • src/lib/faq.ts — FAQ questions and answers.
  • src/lib/routes.ts — every indexable route, with its title and description.
  • public/sitemap.xml — edited by hand when you add a page.
  • worker — the Cloudflare Worker behind the visitor map.
Adding a page? Register it in src/App.tsx, src/lib/routes.ts and public/sitemap.xml. Docs pages only need an entry in src/docs/pages.tsx and the sitemap.

Sending a pull request

  • Fork the repository and create a branch from main.
  • Keep the change focused. One concern per pull request.
  • Make sure npm run lint and npm run build pass.
  • Describe what changed and why. Add screenshots for visual changes.

By contributing, you agree that your work is released under the project's MIT License.