How do I add a tech stack to my GitHub project?
Use the README for the full picture
The README is the best place to describe your stack in detail. A short section with the main language, framework, database, and deployment target tells visitors what they are looking at. Badges can link to build status or package versions, but keep them to the few that matter.
Write the list as it applies to this project, not to everything you have ever used. A reader who sees a dozen unrelated tools may wonder which ones are actually in use. Naming the versions of major dependencies can also save time when someone clones the repository.
- List the language and framework first
- Add the database and hosting target
- Use GitHub topics for search tags
- Update the section when the stack changes
Tags and repository settings
GitHub topics help people find your project through search and browsing. Add topics for the main languages and frameworks, and avoid stuffing dozens of tags into one repository. A few accurate topics usually work better than a long, vague list.
If the project has a deployment guide, link to it from the stack section. Readers who want to run the app often look for setup steps right after the list of tools, so a link there saves them a search.
Common mistakes
- Listing tools that the project no longer uses.
- Forgetting to update the README after a major migration.
