{"id":13506899,"url":"https://github.com/jehna/readme-best-practices","last_synced_at":"2026-02-02T12:49:33.768Z","repository":{"id":8260733,"uuid":"50298387","full_name":"jehna/readme-best-practices","owner":"jehna","description":"Best practices for writing a README for your open source project","archived":false,"fork":false,"pushed_at":"2023-07-30T16:09:44.000Z","size":29,"stargazers_count":848,"open_issues_count":6,"forks_count":852,"subscribers_count":14,"default_branch":"master","last_synced_at":"2024-01-25T07:31:49.299Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":null,"has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"unlicense","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/jehna.png","metadata":{"files":{"readme":"README-default.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null}},"created_at":"2016-01-24T17:18:17.000Z","updated_at":"2024-04-15T11:20:11.125Z","dependencies_parsed_at":"2024-04-15T11:30:10.187Z","dependency_job_id":null,"html_url":"https://github.com/jehna/readme-best-practices","commit_stats":{"total_commits":13,"total_committers":3,"mean_commits":4.333333333333333,"dds":"0.23076923076923073","last_synced_commit":"561c456d0447442cf1e28bbf9df06621a2581a0d"},"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jehna%2Freadme-best-practices","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jehna%2Freadme-best-practices/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jehna%2Freadme-best-practices/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jehna%2Freadme-best-practices/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/jehna","download_url":"https://codeload.github.com/jehna/readme-best-practices/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":240974402,"owners_count":19887299,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-08-01T01:00:59.619Z","updated_at":"2026-02-02T12:49:28.731Z","avatar_url":"https://github.com/jehna.png","language":null,"funding_links":[],"categories":["Tools","Templates"],"sub_categories":["JetBrains"],"readme":"![Logo of the project](https://raw.githubusercontent.com/jehna/readme-best-practices/master/sample-logo.png)\n\n# Name of the project\n\u003e Additional information or tagline\n\nA brief description of your project, what it is used for and how does life get\nawesome when someone starts to use it.\n\n## Installing / Getting started\n\nA quick introduction of the minimal setup you need to get a hello world up \u0026\nrunning.\n\n```shell\npackagemanager install awesome-project\nawesome-project start\nawesome-project \"Do something!\"  # prints \"Nah.\"\n```\n\nHere you should say what actually happens when you execute the code above.\n\n### Initial Configuration\n\nSome projects require initial configuration (e.g. access tokens or keys, `npm i`).\nThis is the section where you would document those requirements.\n\n## Developing\n\nHere's a brief intro about what a developer must do in order to start developing\nthe project further:\n\n```shell\ngit clone https://github.com/your/awesome-project.git\ncd awesome-project/\npackagemanager install\n```\n\nAnd state what happens step-by-step.\n\n### Building\n\nIf your project needs some additional steps for the developer to build the\nproject after some code changes, state them here:\n\n```shell\n./configure\nmake\nmake install\n```\n\nHere again you should state what actually happens when the code above gets\nexecuted.\n\n### Deploying / Publishing\n\nIn case there's some step you have to take that publishes this project to a\nserver, this is the right time to state it.\n\n```shell\npackagemanager deploy awesome-project -s server.com -u username -p password\n```\n\nAnd again you'd need to tell what the previous code actually does.\n\n## Features\n\nWhat's all the bells and whistles this project can perform?\n* What's the main functionality\n* You can also do another thing\n* If you get really randy, you can even do this\n\n## Configuration\n\nHere you should write what are all of the configurations a user can enter when\nusing the project.\n\n#### Argument 1\nType: `String`  \nDefault: `'default value'`\n\nState what an argument does and how you can use it. If needed, you can provide\nan example below.\n\nExample:\n```bash\nawesome-project \"Some other value\"  # Prints \"You're nailing this readme!\"\n```\n\n#### Argument 2\nType: `Number|Boolean`  \nDefault: 100\n\nCopy-paste as many of these as you need.\n\n## Contributing\n\nWhen you publish something open source, one of the greatest motivations is that\nanyone can just jump in and start contributing to your project.\n\nThese paragraphs are meant to welcome those kind souls to feel that they are\nneeded. You should state something like:\n\n\"If you'd like to contribute, please fork the repository and use a feature\nbranch. Pull requests are warmly welcome.\"\n\nIf there's anything else the developer needs to know (e.g. the code style\nguide), you should link it here. If there's a lot of things to take into\nconsideration, it is common to separate this section to its own file called\n`CONTRIBUTING.md` (or similar). If so, you should say that it exists here.\n\n## Links\n\nEven though this information can be found inside the project on machine-readable\nformat like in a .json file, it's good to include a summary of most useful\nlinks to humans using your project. You can include links like:\n\n- Project homepage: https://your.github.com/awesome-project/\n- Repository: https://github.com/your/awesome-project/\n- Issue tracker: https://github.com/your/awesome-project/issues\n  - In case of sensitive bugs like security vulnerabilities, please contact\n    my@email.com directly instead of using issue tracker. We value your effort\n    to improve the security and privacy of this project!\n- Related projects:\n  - Your other project: https://github.com/your/other-project/\n  - Someone else's project: https://github.com/someones/awesome-project/\n\n\n## Licensing\n\nOne really important part: Give your project a proper license. Here you should\nstate what the license is and how to find the text version of the license.\nSomething like:\n\n\"The code in this project is licensed under MIT license.\"\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fjehna%2Freadme-best-practices","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fjehna%2Freadme-best-practices","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fjehna%2Freadme-best-practices/lists"}