{"id":14111544,"url":"https://github.com/ParanoidUser/awesome-practices","last_synced_at":"2025-08-01T12:33:07.427Z","repository":{"id":108281801,"uuid":"590694679","full_name":"ParanoidUser/awesome-practices","owner":"ParanoidUser","description":"Software engineering best practices 📚","archived":false,"fork":false,"pushed_at":"2025-05-12T08:53:19.000Z","size":153,"stargazers_count":16,"open_issues_count":0,"forks_count":2,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-07-30T15:18:52.253Z","etag":null,"topics":["awesome","awesome-list","best-practices","guidelines","policies","software-engineering"],"latest_commit_sha":null,"homepage":"","language":null,"has_issues":false,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"cc0-1.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/ParanoidUser.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":".github/CONTRIBUTING.md","funding":null,"license":"LICENSE","code_of_conduct":".github/CODE_OF_CONDUCT.md","threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null}},"created_at":"2023-01-19T01:20:26.000Z","updated_at":"2025-07-13T08:05:18.000Z","dependencies_parsed_at":"2023-11-08T06:27:25.577Z","dependency_job_id":"50d51355-4fb7-47d0-81dd-f720fa3295c8","html_url":"https://github.com/ParanoidUser/awesome-practices","commit_stats":{"total_commits":84,"total_committers":2,"mean_commits":42.0,"dds":"0.22619047619047616","last_synced_commit":"75f4abbcdc2f1b4ad96bb2bece3d2b3708cd1a3b"},"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/ParanoidUser/awesome-practices","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ParanoidUser%2Fawesome-practices","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ParanoidUser%2Fawesome-practices/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ParanoidUser%2Fawesome-practices/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ParanoidUser%2Fawesome-practices/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/ParanoidUser","download_url":"https://codeload.github.com/ParanoidUser/awesome-practices/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ParanoidUser%2Fawesome-practices/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":268223216,"owners_count":24215711,"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","status":"online","status_checked_at":"2025-08-01T02:00:08.611Z","response_time":67,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"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":["awesome","awesome-list","best-practices","guidelines","policies","software-engineering"],"created_at":"2024-08-14T10:03:21.171Z","updated_at":"2025-08-01T12:33:07.415Z","avatar_url":"https://github.com/ParanoidUser.png","language":null,"readme":"# Awesome Practices [![Awesome](https://awesome.re/badge.svg)](https://awesome.re)\n\n![banner](https://user-images.githubusercontent.com/5120290/213342525-d7aefbd0-1068-47bd-8a53-f0fb6f61a0dd.png)\n\nA curated list of best practices, guidelines, standards, and conventions accepted for software engineering.\n\n## Contents\n\n- [Design](#design)\n- [Development](#development)\n- [Methodology](#methodology)\n- [Tools](#tools)\n- [Data](#data)\n- [Security](#security)\n- [Culture](#culture)\n\n## Design\n\n*Creating user-friendly and visually appealing software interfaces.*\n\n- [8 Principles of Information Architecture](https://asistdl.onlinelibrary.wiley.com/doi/full/10.1002/bult.2010.1720360609) - Eight principles to help designers make the right decisions when creating their build strategies.\n- [A11Y Project](https://www.a11yproject.com/checklist/) - Community-driven effort to make digital accessibility easier.\n- [BEM Methodology](https://getbem.com) - Front-end naming method for organizing and naming CSS classes.\n- [Contrast Rebellion](https://contrastrebellion.com) - Multitude of accessibility problems with unreadable, low-contrast texts.\n- [Guide to Accessible Form Validation](https://www.smashingmagazine.com/2023/02/guide-accessible-form-validation/) - Considerations, so that nobody gets stuck on an inaccessible invalid field.\n- [Laws of UX](https://lawsofux.com) - Collection of best practices that designers can consider when building user interfaces.\n- [Material Design Guidelines](https://m2.material.io/design/guidelines-overview) - Usability and platform guidance describe how to make sure your app is usable for all users.\n\n## Development\n\n*Writing code to build software applications.*\n\n- [Android Developer Guides](https://developer.android.com/guide) - These documents teach you how to build Android apps using APIs in the Android framework and other libraries.\n- [AWS Well-Architected](https://aws.amazon.com/architecture/well-architected/) - Helps cloud architects build secure, high-performing, resilient, and efficient infrastructure for a variety of applications and workloads.\n- [Best practices for writing Dockerfiles](https://docs.docker.com/develop/develop-images/dockerfile_best-practices) - This topic covers recommended best practices and methods for building efficient images.\n- [Conventional Logs](https://www.conventionallogs.org) - Specification for adding human and machine-readable meaning to log messages.\n- [EKS Best Practices Guides](https://aws.github.io/aws-eks-best-practices/) - Set of best practices for day 2 operations for Amazon EKS.\n- [Google API Design Guide](https://cloud.google.com/apis/design/) - General design guide that Google follows when designing Cloud APIs and other Google APIs.\n- [Go Optimization Guide](https://goperf.dev) - Patterns and Techniques for Writing High-Performance Applications with Go.\n- [Google Best Practices for Java Libraries](https://jlbp.dev) - Rules that minimize problems for consumers of interconnected Java libraries.\n- [Google Cloud Architecture Framework](https://cloud.google.com/architecture/framework) - Provides recommendations and best practices for designing and operating a cloud topology.\n- [Google Engineering Practices](https://google.github.io/eng-practices/) - Collective experience of various best practices that were developed over time in Google.\n- [Google Style Guides](https://google.github.io/styleguide/) - Complete definition of Google's coding standards for different languages.\n- [Guiding Principles of REST](https://restfulapi.net/rest-architectural-constraints/) - Guiding principles for designing loosely coupled applications over the network.\n- [Hitchhiker's Guide to Python!](https://docs.python-guide.org) - Best practice handbook for the installation, configuration, and usage of Python on a daily basis.\n- [Java Version Almanac](https://javaalmanac.io) - Systematic collection of information about the history and the future of Java.\n- [OpenFeature](https://openfeature.dev) - Open specification that provides a vendor-agnostic, community-driven API for feature flagging that works with your favorite feature flag management tool.\n- [Prompt Engineering](https://www.promptingguide.ai) - Project by DAIR.AI that aims to educate researchers and practitioners about prompt engineering.\n- [Style Guide for Protobuf](https://docs.buf.build/best-practices/style-guide/) - This document is meant as a short reference for developers to refer to when writing Protobuf schemas.\n- [Kubernetes Configuration Best Practices](https://kubernetes.io/docs/concepts/configuration/overview/) - Consolidates configuration best practices that are introduced throughout the user guide, Getting Started documentation, and examples.\n\n## Methodology\n\n*Methods for software development, delivery, and maintenance.*\n\n- [C4 Model](https://c4model.com) - An easy to learn, developer friendly approach to software architecture diagramming.\n- [Conventional Commits](https://www.conventionalcommits.org) - Specification for adding human and machine-readable meaning to commit messages.\n- [Functional Documentation](https://heydonworks.com/article/functional-documentation/) - Some collected thoughts and ideas around applying a functional approach to writing and maintaining documentation, especially for design systems.\n- [GitLab Documentation Style Guide](https://docs.gitlab.com/ee/development/documentation/styleguide/) - Standards for GitLab documentation, including grammar, formatting, word use, and more.\n- [Java Design Patterns](https://java-design-patterns.com) - Software design patterns, principles, and snippets.\n- [Keep Changelog](https://keepachangelog.com) - Guidelines for maintaining a curated, chronologically ordered list of notable changes for each version of a project.\n- [Manifesto for Agile Software Development](https://agilemanifesto.org/iso/en/manifesto.html) - Outlines the central values and principles of Agile software development.\n- [Manifesto for Fluid Software Development](https://fluidmanifesto.org) - Defines a new approach to software development focused on fluidity and adaptability.\n- [Minimum Viable CD](https://minimumcd.org) - Set of practices that give the expected improvements to organizational structure that come with continuous delivery.\n- [Open GitOps](https://opengitops.dev) - Set of open-source standards, best practices, and community-focused education to help organizations adopt a structured, standardized approach to implementing GitOps.\n- [Patterns for Managing Source Code Branches](https://martinfowler.com/articles/branching-patterns.html) - Patterns that can allow teams to use branching effectively, concentrating around integrating the work of multiple developers and organizing the path to production releases.\n- [Semantic Versioning](https://semver.org) - Formal convention for determining the version number of new software releases.\n- [The Twelve-Factor App](https://12factor.net) - Methodology for building software-as-a-service applications.\n- [Trunk Based Development](https://trunkbaseddevelopment.com) - Version management practice where developers merge small, frequent updates into a \"trunk\" or main branch.\n- [Write the Docs](https://www.writethedocs.org/guide/) - Collective wisdom of the Write the Docs community around best practices for creating software documentation.\n- [Writing Better Release Notes](https://simonwillison.net/2022/Jan/31/release-notes/) - Some thoughts on how to write better release notes.\n\n## Tools\n\n*Software and hardware for software development and testing.*\n\n- [Choose a License](https://choosealicense.com) - Non-judgmental guidance on choosing a license for your open source project.\n- [Command Line Interface Guidelines](https://clig.dev) - Guide to help you write better command-line programs.\n- [Command-not-found](https://command-not-found.com) - Helpful tool for installing any command on any operating system.\n- [End-of-life](https://endoflife.date) - Documents EOL dates and support lifecycles for various products.\n- [Gitignore](https://gitignore.io) - Web service designed to help you create .gitignore files for your Git repositories.\n- [IP Guide](https://ip.guide) - Easy to use API for looking up IP, Network, and ASN data.\n- [Maven Code Style and Code Conventions](https://maven.apache.org/developers/conventions/code.html) - Rules for how the sources should be formatted in order to improve consistency, readability, and maintainability.\n- [Terraform Best Practices](https://www.terraform-best-practices.com) - Best practices for using Terraform and recommendations for the most common issues.\n- [Think Like (a) Git](https://think-like-a-git.net) - Guide to help understand how Git works under the hood.\n- [Typograms](https://google.github.io/typograms/) - Lightweight image format useful for defining simple diagrams in technical documentation.\n\n## Data\n\n*Information storage, processing, and analysis in software.*\n\n- [MLOps Principles](https://ml-ops.org/content/mlops-principles) - Best practices and tools to test, deploy, manage, and monitor ML models in real-world production.\n- [Transparent Telemetry](https://research.swtch.com/telemetry) - Designed to give developers the information they need to be effective without having to track detailed user activity.\n\n## Security\n\n*Protecting software from attacks and misuse.*\n\n- [Node.js Security Best Practices](https://nodejs.org/en/docs/guides/security) - This document intends to extend the current [threat model](https://github.com/nodejs/node/security/policy#the-nodejs-threat-model) and provide extensive guidelines on how to secure a Node.js application.\n- [OWASP Top 10](https://owasp.org/Top10/) - Standard awareness document for developers and web application security.\n- [security.txt](https://securitytxt.org) - A proposed standard which allows websites to define security policies.\n- [TLS Cipher Suite Search](https://ciphersuite.info) - Searchable directory of TLS cipher suites and related security details.\n\n## Culture\n\n*Values and practices influencing software development.*\n\n- [Amazon Leadership Principles](https://www.amazon.jobs/content/en/our-workplace/leadership-principles) - Core principles for discussing ideas for new projects or deciding the best way to solve a problem in everyday life.\n- [Code of Conduct for Open Source Communities](https://www.contributor-covenant.org) - Set of rules outlining the norms, rules, and responsibilities or proper practices of an individual party or an organization.\n- [Conventional Comments](https://conventionalcomments.org) - Standard for formatting comments of any kind of review/feedback process.\n- [DORA Guides](https://dora.dev/guides/) - Long running research program that seeks to understand the capabilities that drive software delivery and operations performance.\n- [Dangit, Git!?!](https://dangitgit.com) - List of common Git issues and ways to work around them.\n- [Developer Marketing Guide](https://www.devmarketingguide.com) - Learn about essential developer content types, distribution plans, community projects, tools, services, and more.\n- [Developer Roadmaps](https://roadmap.sh) - Step-by-step guides and paths to learn different tools or technologies.\n- [Hacker Laws](https://hacker-laws.com) - Laws, Theories, Principles and Patterns that developers will find useful.\n- [JSON Resume](https://jsonresume.org) - Open source initiative to create a JSON-based standard for resumes.\n- [Open Source Guides](https://opensource.guide) - Collection of resources for individuals, communities, and companies who want to learn how to run and contribute to an open-source project.\n- [Principles of Green Software Engineering](https://principles.green) - Set of competencies needed to define, build and run green software applications.\n- [StaffEng](https://staffeng.com/guides) - Guides for reaching and succeeding at Staff-plus roles.\n- [Which Version of JDK Should I Use?](https://whichjdk.com) - This site gives independent, yet opinionated recommendations.\n","funding_links":[],"categories":["Other Lists"],"sub_categories":["TeX Lists"],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2FParanoidUser%2Fawesome-practices","html_url":"https://awesome.ecosyste.ms/projects/github.com%2FParanoidUser%2Fawesome-practices","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2FParanoidUser%2Fawesome-practices/lists"}