GitHub README and Contributing Guide for an Open Source Project
Write the first pages new users and contributors read.
The Open buttons send the prompt text as currently shown below to that site only when you click. Fill in the placeholders first.
Write a README and a CONTRIBUTING guide. Project name and one-sentence purpose: [PROJECT_PURPOSE]. Who it is for: [AUDIENCE]. How to install and run it, as the maintainer describes: [INSTALL_STEPS]. Main features: [FEATURES]. Licence and code of conduct: [LICENCE_AND_CONDUCT]. How to run tests: [TEST_COMMANDS]. How contributions are reviewed: [REVIEW_PROCESS]. README: title and badges placeholder, what it does in two sentences, a quick start of no more than five commands, usage examples, a configuration table, project status, links to documentation, how to get help, and licence. CONTRIBUTING: ways to contribute, setting up a development environment, branch and commit message conventions, required tests, the pull request process, review expectations and timing, how to report problems or security concerns privately, a friendly paragraph for first-time contributors, and good first issue placeholders. Use only the commands and facts I supplied; write [ADD COMMAND] for a missing command and do not invent flags or package names. Write for someone who has never seen the project: short, accurate and welcoming. Verify the README by having a new person follow the quick start on a clean machine and report where they got stuck. Keep the documents in step with the code by updating them in the same pull request as a change.
Fill in before use
Optional: type your details and the prompt above updates. Nothing is saved or sent.
Replace each bracketed placeholder with your own details, then paste into Any AI or another assistant.