├── .editorconfig ├── .gitattributes ├── .github ├── dependabot.yml ├── pull_request_template.md └── workflows │ ├── lint.yml │ └── stale.yml ├── .gitignore ├── LICENSE ├── README.md ├── assets └── header.png ├── code-of-conduct.md ├── contributing.md ├── package-lock.json ├── package.json ├── test.js └── travis.yml /.editorconfig: -------------------------------------------------------------------------------- 1 | root = true 2 | 3 | [*] 4 | charset = utf-8 5 | indent_style = space 6 | indent_size = 2 7 | end_of_line = lf 8 | trim_trailing_whitespace = true 9 | insert_final_newline = true 10 | -------------------------------------------------------------------------------- /.gitattributes: -------------------------------------------------------------------------------- 1 | * text=auto 2 | readme.md merge=union 3 | -------------------------------------------------------------------------------- /.github/dependabot.yml: -------------------------------------------------------------------------------- 1 | version: 2 2 | updates: 3 | - package-ecosystem: "npm" 4 | directory: "/" 5 | schedule: 6 | interval: "daily" 7 | reviewers: 8 | - "kristories" 9 | assignees: 10 | - "kristories" 11 | -------------------------------------------------------------------------------- /.github/pull_request_template.md: -------------------------------------------------------------------------------- 1 | **By submitting this pull request, I promise I have read the [contribution guidelines](https://github.com/Kristories/awesome-guidelines/blob/master/contributing.md) twice and ensured my submission follows it. I realize not doing so wastes the maintainers' time that they could have spent making the world better. 🖖** 2 | 3 | ⬆⬆⬆⬆⬆⬆⬆⬆⬆⬆ 4 | -------------------------------------------------------------------------------- /.github/workflows/lint.yml: -------------------------------------------------------------------------------- 1 | name: Lint 2 | on: 3 | pull_request: 4 | branches: [ master ] 5 | 6 | jobs: 7 | build: 8 | runs-on: ubuntu-latest 9 | 10 | steps: 11 | - uses: actions/checkout@v2 12 | with: 13 | fetch-depth: 0 14 | - run: npx awesome-lint 15 | -------------------------------------------------------------------------------- /.github/workflows/stale.yml: -------------------------------------------------------------------------------- 1 | name: Mark stale issues and pull requests 2 | 3 | on: 4 | schedule: 5 | - cron: "59 23 * * *" 6 | 7 | jobs: 8 | stale: 9 | 10 | runs-on: ubuntu-latest 11 | 12 | steps: 13 | - uses: actions/stale@v1 14 | with: 15 | days-before-stale: 20 16 | days-before-close: 1 17 | repo-token: ${{ secrets.GITHUB_TOKEN }} 18 | stale-issue-message: 'This issue has been hanging around a bit too long, if needed please update or comment.' 19 | stale-pr-message: 'This PR has been hanging around a bit too long, please update/rebase or comment as needed.' 20 | stale-issue-label: 'no-issue-activity' 21 | stale-pr-label: 'no-pr-activity' 22 | -------------------------------------------------------------------------------- /.gitignore: -------------------------------------------------------------------------------- 1 | node_modules/ 2 | -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | CC0 1.0 Universal 2 | 3 | Statement of Purpose 4 | 5 | The laws of most jurisdictions throughout the world automatically confer 6 | exclusive Copyright and Related Rights (defined below) upon the creator and 7 | subsequent owner(s) (each and all, an "owner") of an original work of 8 | authorship and/or a database (each, a "Work"). 9 | 10 | Certain owners wish to permanently relinquish those rights to a Work for the 11 | purpose of contributing to a commons of creative, cultural and scientific 12 | works ("Commons") that the public can reliably and without fear of later 13 | claims of infringement build upon, modify, incorporate in other works, reuse 14 | and redistribute as freely as possible in any form whatsoever and for any 15 | purposes, including without limitation commercial purposes. These owners may 16 | contribute to the Commons to promote the ideal of a free culture and the 17 | further production of creative, cultural and scientific works, or to gain 18 | reputation or greater distribution for their Work in part through the use and 19 | efforts of others. 20 | 21 | For these and/or other purposes and motivations, and without any expectation 22 | of additional consideration or compensation, the person associating CC0 with a 23 | Work (the "Affirmer"), to the extent that he or she is an owner of Copyright 24 | and Related Rights in the Work, voluntarily elects to apply CC0 to the Work 25 | and publicly distribute the Work under its terms, with knowledge of his or her 26 | Copyright and Related Rights in the Work and the meaning and intended legal 27 | effect of CC0 on those rights. 28 | 29 | 1. Copyright and Related Rights. A Work made available under CC0 may be 30 | protected by copyright and related or neighboring rights ("Copyright and 31 | Related Rights"). Copyright and Related Rights include, but are not limited 32 | to, the following: 33 | 34 | i. the right to reproduce, adapt, distribute, perform, display, communicate, 35 | and translate a Work; 36 | 37 | ii. moral rights retained by the original author(s) and/or performer(s); 38 | 39 | iii. publicity and privacy rights pertaining to a person's image or likeness 40 | depicted in a Work; 41 | 42 | iv. rights protecting against unfair competition in regards to a Work, 43 | subject to the limitations in paragraph 4(a), below; 44 | 45 | v. rights protecting the extraction, dissemination, use and reuse of data in 46 | a Work; 47 | 48 | vi. database rights (such as those arising under Directive 96/9/EC of the 49 | European Parliament and of the Council of 11 March 1996 on the legal 50 | protection of databases, and under any national implementation thereof, 51 | including any amended or successor version of such directive); and 52 | 53 | vii. other similar, equivalent or corresponding rights throughout the world 54 | based on applicable law or treaty, and any national implementations thereof. 55 | 56 | 2. Waiver. To the greatest extent permitted by, but not in contravention of, 57 | applicable law, Affirmer hereby overtly, fully, permanently, irrevocably and 58 | unconditionally waives, abandons, and surrenders all of Affirmer's Copyright 59 | and Related Rights and associated claims and causes of action, whether now 60 | known or unknown (including existing as well as future claims and causes of 61 | action), in the Work (i) in all territories worldwide, (ii) for the maximum 62 | duration provided by applicable law or treaty (including future time 63 | extensions), (iii) in any current or future medium and for any number of 64 | copies, and (iv) for any purpose whatsoever, including without limitation 65 | commercial, advertising or promotional purposes (the "Waiver"). Affirmer makes 66 | the Waiver for the benefit of each member of the public at large and to the 67 | detriment of Affirmer's heirs and successors, fully intending that such Waiver 68 | shall not be subject to revocation, rescission, cancellation, termination, or 69 | any other legal or equitable action to disrupt the quiet enjoyment of the Work 70 | by the public as contemplated by Affirmer's express Statement of Purpose. 71 | 72 | 3. Public License Fallback. Should any part of the Waiver for any reason be 73 | judged legally invalid or ineffective under applicable law, then the Waiver 74 | shall be preserved to the maximum extent permitted taking into account 75 | Affirmer's express Statement of Purpose. In addition, to the extent the Waiver 76 | is so judged Affirmer hereby grants to each affected person a royalty-free, 77 | non transferable, non sublicensable, non exclusive, irrevocable and 78 | unconditional license to exercise Affirmer's Copyright and Related Rights in 79 | the Work (i) in all territories worldwide, (ii) for the maximum duration 80 | provided by applicable law or treaty (including future time extensions), (iii) 81 | in any current or future medium and for any number of copies, and (iv) for any 82 | purpose whatsoever, including without limitation commercial, advertising or 83 | promotional purposes (the "License"). The License shall be deemed effective as 84 | of the date CC0 was applied by Affirmer to the Work. Should any part of the 85 | License for any reason be judged legally invalid or ineffective under 86 | applicable law, such partial invalidity or ineffectiveness shall not 87 | invalidate the remainder of the License, and in such case Affirmer hereby 88 | affirms that he or she will not (i) exercise any of his or her remaining 89 | Copyright and Related Rights in the Work or (ii) assert any associated claims 90 | and causes of action with respect to the Work, in either case contrary to 91 | Affirmer's express Statement of Purpose. 92 | 93 | 4. Limitations and Disclaimers. 94 | 95 | a. No trademark or patent rights held by Affirmer are waived, abandoned, 96 | surrendered, licensed or otherwise affected by this document. 97 | 98 | b. Affirmer offers the Work as-is and makes no representations or warranties 99 | of any kind concerning the Work, express, implied, statutory or otherwise, 100 | including without limitation warranties of title, merchantability, fitness 101 | for a particular purpose, non infringement, or the absence of latent or 102 | other defects, accuracy, or the present or absence of errors, whether or not 103 | discoverable, all to the greatest extent permissible under applicable law. 104 | 105 | c. Affirmer disclaims responsibility for clearing rights of other persons 106 | that may apply to the Work or any use thereof, including without limitation 107 | any person's Copyright and Related Rights in the Work. Further, Affirmer 108 | disclaims responsibility for obtaining any necessary consents, permissions 109 | or other rights required for any use of the Work. 110 | 111 | d. Affirmer understands and acknowledges that Creative Commons is not a 112 | party to this document and has no duty or obligation with respect to this 113 | CC0 or use of the Work. 114 | 115 | For more information, please see 116 | 117 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 |

2 | 3 | Awesome Guidelines 4 | 5 |

6 | 7 | # Awesome Guidelines [![Awesome](https://awesome.re/badge-flat2.svg)](https://awesome.re) 8 | 9 | A set of guidelines for a specific programming language that provides recommendations on programming style, best practices, and methods for various aspects of writing programs in that language. 10 | 11 | Please see [CONTRIBUTING](contributing.md) and [CODE-OF-CONDUCT](code-of-conduct.md) for details. 12 | 13 | ## Contents 14 | 15 | - [Programming Languages](#programming-languages) 16 | - [Development Environment](#development-environment) 17 | - [Platforms](#platforms) 18 | - [Frameworks](#frameworks) 19 | - [Content Management System](#content-management-system) 20 | - [Tools](#tools) 21 | 22 | ## Programming Languages 23 | 24 | ### Brainfuck 25 | 26 | - [BF Style Guide](https://codepen.io/renmans/full/JjdJPpW) 27 | 28 | ### C 29 | 30 | - [C Coding Standard](https://users.ece.cmu.edu/~eno/coding/CCodingStandard.html) 31 | - [C Programming/Structure and style](https://en.wikibooks.org/wiki/C_Programming/Structure_and_style) 32 | - [Making The Best Use of C](https://www.gnu.org/prep/standards/html_node/Writing-C.html) - This chapter provides advice on how best to use the C language when writing GNU software. 33 | 34 | ### C# 35 | 36 | - [C# Coding Conventions](https://learn.microsoft.com/en-us/dotnet/csharp/fundamentals/coding-style/coding-conventions) 37 | - [C# Style Guide](https://github.com/kodecocodes/c-sharp-style-guide) 38 | - [C# Coding Standards and Naming Conventions](http://www.dofactory.com/reference/csharp-coding-standards) 39 | 40 | ### C++ 41 | 42 | - [Google C++ Style Guide](https://google.github.io/styleguide/cppguide.html) 43 | - [C++ Core Guidelines](http://isocpp.github.io/CppCoreGuidelines/CppCoreGuidelines) - A set of tried-and-true guidelines, rules, and best practices about coding in C++. 44 | - [LLVM C++ Coding Standards](https://llvm.org/docs/CodingStandards.html) 45 | - [Mozilla C++ Coding style](https://firefox-source-docs.mozilla.org/code-quality/coding-style/coding_style_cpp.html) 46 | - [Chromium C++ style guide](https://chromium.googlesource.com/chromium/src/+/HEAD/styleguide/c++/c++.md) 47 | - [Webkit C++ Code Style Guidelines](https://webkit.org/code-style-guidelines/) 48 | - [NASA C++ Coding Standards and Style Guide](https://ntrs.nasa.gov/api/citations/20080039927/downloads/20080039927.pdf) 49 | - [OceanBase C++ Coding Standards](https://oceanbase.github.io/oceanbase/coding_standard.html) 50 | 51 | ### Clojure 52 | 53 | - [The Clojure Style Guide](https://github.com/bbatsov/clojure-style-guide) - A community coding style guide for the Clojure programming language. 54 | 55 | ### Common Lisp 56 | 57 | - [Style Guide](http://lisp-lang.org/style-guide/) 58 | - [Google Common Lisp Style Guide](https://google.github.io/styleguide/lispguide.xml) 59 | - [Common Lisp Style Guide](http://labs.ariel-networks.com/cl-style-guide.html) 60 | 61 | ### D 62 | 63 | - [The D Style](https://dlang.org/dstyle.html) - A set of style conventions for writing D programs. 64 | 65 | ### Dart 66 | 67 | - [Effective Dart](https://dart.dev/effective-dart) 68 | 69 | ### Delphi 70 | 71 | - [Delphi's Object Pascal Style Guide](https://docwiki.embarcadero.com/RADStudio/Alexandria/en/Delphi%E2%80%99s_Object_Pascal_Style_Guide) 72 | 73 | ### Elixir 74 | 75 | - [Elixir Styleguide](https://github.com/christopheradams/elixir_style_guide) 76 | 77 | ### Elm 78 | 79 | - [Elm style guide](http://elm-lang.org/docs/style-guide) 80 | 81 | ### Emacs Lisp 82 | 83 | - [Elisp Guide](https://github.com/chrisdone/elisp-guide) 84 | - [Emacs Lisp Style Guide](https://github.com/bbatsov/emacs-lisp-style-guide) 85 | 86 | ### Erlang 87 | 88 | - [Programming Rules and Conventions](http://www.erlang.se/doc/programming_rules.shtml) 89 | - [Erlang Coding Guidelines](https://github.com/inaka/erlang_guidelines) 90 | 91 | ### F# 92 | 93 | - [The F# Component Design Guidelines](https://learn.microsoft.com/en-us/dotnet/fsharp/style-guide/component-design-guidelines) 94 | 95 | ### Fortran 96 | 97 | - [Fortran 90 Standards](http://research.metoffice.gov.uk/research/nwp/numerical/fortran90/f90_standards.html) - European Standards For Writing and Documenting Exchangeable Fortran 90 Code. 98 | - [Fortran Best Practices](https://fortran-lang.org/en/learn/best_practices/) - Style guide and best practices for modern Fortran programs. 99 | 100 | ### Go 101 | 102 | - [Effective Go](https://go.dev/doc/effective_go) 103 | - [Go Standard Project Layout](https://github.com/golang-standards/project-layout) - Basic layout for Go applications. 104 | - [Google Go Style Guide](https://google.github.io/styleguide/go) - Google's coding standards for source code in Go. 105 | - [Uber Go Style Guide](https://github.com/uber-go/guide/blob/master/style.md) - Patterns and conventions used in Go code at Uber. 106 | 107 | ### Groovy 108 | 109 | - [Apache Groovy style guide](http://groovy-lang.org/style-guide.html) 110 | 111 | ### Haskell 112 | 113 | - [Haskell Programming guidelines](https://wiki.haskell.org/Programming_guidelines) 114 | 115 | ### Java 116 | 117 | - [Code Conventions for the Java™ Programming Language](http://www.oracle.com/technetwork/java/codeconvtoc-136057.html) 118 | - [Google Java Style Guide](https://google.github.io/styleguide/javaguide.html) - Google's coding standards for source code in the Java™ Programming Language. 119 | - [Java Programming Style Guide](http://javaranch.com/style.jsp) 120 | - [Alibaba-Java-Coding-Guidelines](https://alibaba.github.io/Alibaba-Java-Coding-Guidelines/) - A guide for Java developers. 121 | 122 | ### JavaScript 123 | 124 | - [AngularJS Style Guide](https://github.com/mgechev/angularjs-style-guide) - Community-driven set of best practices for AngularJS application development. 125 | - [JavaScript The Right Way](http://jstherightway.org) - An easy-to-read, quick reference for JS best practices, accepted coding standards, and links around the Web. 126 | - [Google JavaScript Style Guide](https://google.github.io/styleguide/jsguide.html) - This document serves as the complete definition of Google's coding standards for source code in the JavaScript programming language. 127 | - [Airbnb JavaScript Style Guide](https://github.com/airbnb/javascript) - A mostly reasonable approach to JavaScript. 128 | - [jQuery Core Style Guide](http://contribute.jquery.org/style-guide/js/) 129 | - [JavaScript Style Guides And Beautifiers](https://addyosmani.com/blog/javascript-style-guides-and-beautifiers/) 130 | - [JavaScript Style Guide and Coding Conventions](https://www.w3schools.com/js/js_conventions.asp) 131 | - [Code Conventions for the JavaScript](http://crockford.com/javascript/code.html) 132 | - [JavaScript Clean Code](https://github.com/ryanmcdermott/clean-code-javascript) - Software engineering principles, from Robert C. Martin's book [Clean Code](https://www.amazon.com/Clean-Code-Handbook-Software-Craftsmanship/dp/0132350882), adapted for JavaScript. 133 | - [Mozilla Coding Style Guide for JavaScript](https://developer.mozilla.org/en-US/docs/MDN/Writing_guidelines/Writing_style_guide/Code_style_guide/JavaScript) 134 | 135 | ### JSON 136 | 137 | - [Google JSON Style Guide](https://google.github.io/styleguide/jsoncstyleguide.xml) 138 | 139 | ### Julia 140 | 141 | - [Blue Style](https://github.com/JuliaDiff/BlueStyle) 142 | 143 | ### Kotlin 144 | 145 | - [Coding Conventions](https://kotlinlang.org/docs/coding-conventions.html) 146 | 147 | ### Lua 148 | 149 | - [Lua Style Guide](http://lua-users.org/wiki/LuaStyleGuide) 150 | 151 | ### Markdown 152 | 153 | - [Google Markdown Style Guide](https://github.com/google/styleguide/blob/gh-pages/docguide/style.md) - Style guide for Google-originated projects using Markdown. 154 | - [Markdown Style Guide](http://www.cirosantilli.com/markdown-style-guide/) 155 | - [GitLab Markdown Style Guide](https://about.gitlab.com/handbook/markdown-guide/) - Markdown Style Guide for about.GitLab.com. 156 | 157 | ### .NET 158 | 159 | - [.NET Standard](https://github.com/dotnet/standard) 160 | - [.NET Secure Coding Guidelines](https://learn.microsoft.com/en-us/dotnet/standard/security/secure-coding-guidelines) 161 | - [.NET Naming Guidelines](https://learn.microsoft.com/en-us/dotnet/standard/design-guidelines/naming-guidelines) 162 | 163 | ### Nim 164 | 165 | - [Nim Style Guide](https://nim-lang.org/docs/nep1.html) 166 | 167 | ### Objective-C 168 | 169 | - [Objective-C Style guide](https://github.com/github/objective-c-style-guide) - Style guide & coding conventions for Objective-C projects. 170 | - [Google Objective-C Style Guide](https://github.com/google/styleguide/blob/gh-pages/objcguide.md) 171 | - [NYTimes Objective-C Style Guide](https://github.com/NYTimes/objective-c-style-guide) - The Objective-C Style Guide used by The New York Times. 172 | 173 | ### Pascal 174 | 175 | - [Coding style](http://wiki.freepascal.org/Coding_style) 176 | - [GNU Pascal Coding Standards](https://edoras.sdsu.edu/doc/gpcs-en.html) - GNU Pascal standards used by GNU Pascal project. 177 | 178 | ### Perl 179 | 180 | - [Perl best practices v4](https://www.slideshare.net/RandalSchwartz/perl-best-practices-v4) - Slides by Randal Schwartz, based on the book by Damian Conway. 181 | - [Perl Elements to Avoid](http://perl-begin.org/tutorials/bad-elements/) - A list of unrecommended practices, and what to do instead. 182 | - [perlstyle](https://perldoc.perl.org/perlstyle) 183 | 184 | ### PHP 185 | 186 | - [PHP FIG](http://www.php-fig.org/psr/) - PHP Standards Recommendations. 187 | - [PHP The Right Way](http://www.phptherightway.com) - An easy-to-read, quick reference for PHP best practices, accepted coding standards, and links to authoritative tutorials around the Web. 188 | - [Clean Code PHP](https://github.com/piotrplenik/clean-code-php) - Clean Code concepts adapted for PHP. 189 | 190 | ### Python 191 | 192 | - [Style Guide for Python Code](https://peps.python.org/pep-0008/) 193 | - [Google Python Style Guide](https://google.github.io/styleguide/pyguide.html) 194 | - [The Hitchhiker's Guide to Python](https://docs.python-guide.org/) - Highly regarded Python best practices guide. 195 | 196 | ### R 197 | 198 | - [Google's R Style Guide](https://google.github.io/styleguide/Rguide.html) 199 | - [The tidyverse style guide](http://style.tidyverse.org) 200 | 201 | ### Racket 202 | 203 | - [How to Program Racket: a Style Guide](http://docs.racket-lang.org/style/index.html) 204 | 205 | ### Ruby 206 | 207 | - [The Ruby Style Guide](https://rubystyle.guide) - A community-driven Ruby coding style guide. 208 | - [Ruby Style Guide](https://github.com/airbnb/ruby) - Airbnb's Ruby Style Guide. 209 | - [Ruby Style Guide](https://github.com/rubocop/ruby-style-guide) - A community-driven Ruby coding style guide. 210 | 211 | ### Rust 212 | 213 | - [Rust Style Guide](https://github.com/rust-lang/rust/tree/HEAD/src/doc/style-guide/src) 214 | - [Rust Guidelines](http://aturon.github.io) 215 | - [Rust API Guidelines](https://rust-lang.github.io/api-guidelines/) 216 | 217 | ### Scala 218 | 219 | - [Effective Scala](https://twitter.github.io/effectivescala/) 220 | - [Scala Style Guide](http://docs.scala-lang.org/style/) 221 | - [Databricks Scala Guide](https://github.com/databricks/scala-style-guide) - Databricks Scala Coding Style Guide. 222 | - [Scala Best Practices](https://github.com/alexandru/scala-best-practices) 223 | 224 | ### Solidity 225 | 226 | - [Solidity Style Guide](https://docs.soliditylang.org/en/latest/style-guide.html) 227 | - [Solcurity Standard](https://github.com/transmissions11/solcurity) 228 | 229 | ### Swift 230 | 231 | - [API Design Guidelines](https://www.swift.org/documentation/api-design-guidelines/) 232 | - [Swift](https://github.com/github/swift-style-guide) - GitHub Official Swift style and conventions. 233 | - [Swift style guide](https://github.com/kodecocodes/swift-style-guide) 234 | - [Swift Style Guide](https://github.com/linkedin/swift-style-guide) - LinkedIn Official Swift Style Guide. 235 | - [Metova's Swift style guide](https://github.com/metova/swift-style-guide) 236 | - [Xmartlabs Swift Style Guide](https://github.com/xmartlabs/Swift-Style-Guide) - Swift language style guide & coding conventions followed by Xmartlabs. 237 | 238 | ### TypeScript 239 | 240 | - [Google TypeScript Style Guide](https://google.github.io/styleguide/tsguide.html) - TypeScript Style Guide used at Google's. 241 | - [Typescript deep dive - Style Guide](https://basarat.gitbook.io/typescript/styleguide) - An unofficial TypeScript Style Guide. 242 | - [Typescript Lang - Do's and Don'ts](https://www.typescriptlang.org/docs/handbook/declaration-files/do-s-and-don-ts.html) - Suggestions from Typescript Lang organization. 243 | 244 | ### Visual Basic 245 | 246 | - [Visual Basic Concepts]() 247 | - [Visual Basic/Coding Standards](https://en.wikibooks.org/wiki/Visual_Basic/Coding_Standards) 248 | 249 | ### XML 250 | 251 | - [Google XML Document Format Style Guide](https://google.github.io/styleguide/xmlstyle.html) 252 | 253 | ## Development Environment 254 | 255 | ### Shell 256 | 257 | - [Shell Style Guide](https://google.github.io/styleguide/shellguide.html) 258 | 259 | ### Git 260 | 261 | - [Git Style Guide](https://github.com/agis/git-style-guide) 262 | - [Few Rules from Git Documentation](https://github.com/git/git/blob/master/Documentation/CodingGuidelines) 263 | 264 | ### PowerShell 265 | 266 | - [The PowerShell Best Practices and Style Guide](https://github.com/PoshCode/PowerShellPracticeAndStyle) - The Unofficial PowerShell Best Practices and Style Guide. 267 | 268 | ## Platforms 269 | 270 | ### Android 271 | 272 | - [Android Guidelines](https://github.com/ribot/android-guidelines) - Architecture and code guidelines we use at ribot when developing for Android. 273 | - [Xmartlabs Android Style Guide](https://github.com/xmartlabs/Android-Style-Guide) - Style guide for Android by Xmartlabs. 274 | 275 | ### Apache 276 | 277 | - [Apache Developers' C Language Style Guide](http://httpd.apache.org/dev/styleguide.html) 278 | 279 | ### API 280 | 281 | - [HAL](http://stateless.co/hal_specification.html) - A simple format that gives a consistent and easy way to hyperlink between resources in your API. 282 | - [Microsoft REST API Guidelines](https://github.com/Microsoft/api-guidelines) - The Microsoft REST API Guidelines. 283 | - [JSON API - Recommendations](http://jsonapi.org/recommendations) - This section contains recommendations for JSON API implementations. 284 | - [API Security Checklist](https://github.com/shieldfy/API-Security-Checklist) - Checklist of the most important security countermeasures when designing, testing, and releasing your API. 285 | - [Google Cloud API Design Guide](https://cloud.google.com/apis/design) - A general design guide for networked APIs provided by Google. 286 | 287 | ### Arduino 288 | 289 | - [Arduino style guide](https://www.arduino.cc/) 290 | - [API Style Guide for Arduino](https://docs.arduino.cc/learn/contributions/arduino-library-style-guide/) 291 | 292 | ### Frontend Development 293 | 294 | - [CSS Guidelines](https://cssguidelin.es) - High-level advice and guidelines for writing sane, manageable, scalable CSS. 295 | - [Frontend Guidelines](https://github.com/bendc/frontend-guidelines) - Some HTML, CSS and JS best practices. 296 | - [Sass Guidelines](https://sass-guidelin.es) - An opinionated styleguide for writing sane, maintainable and scalable Sass. 297 | - [Airbnb CSS / Sass Styleguide](https://github.com/airbnb/css) - A mostly reasonable approach to CSS and Sass. 298 | - [HTML Style Guide](https://github.com/marcobiedermann/html-style-guide) - A style guide which helps you write better, performant, structured, scalable and maintainable HTML. 299 | - [HTML + CSS Code Guide](http://codeguide.co) - Standards for flexible, durable, and sustainable HTML and CSS. 300 | - [U.S. Web Design Standards](https://designsystem.digital.gov/) - Open source UI components and visual style guide for U.S. government websites. 301 | - [CoffeeScript Style Guide](https://github.com/polarmobile/coffeescript-style-guide) - A collection of best-practices and coding conventions for the CoffeeScript programming language. 302 | - [LESS Coding Guidelines](https://gist.github.com/fat/a47b882eb5f84293c4ed) 303 | - [Google HTML/CSS Style Guide](https://google.github.io/styleguide/htmlcssguide.html) 304 | - [Guidelines for Responsive Web Design](https://www.smashingmagazine.com/2011/01/guidelines-for-responsive-web-design/) 305 | - [Yelp Styleguide](https://www.yelp.com/styleguide) 306 | - [Front-End Checklist](https://github.com/thedaviddias/Front-End-Checklist) 307 | - [BEM - Block Element Modifier](https://getbem.com/) - A methodology that helps you to create reusable components and code sharing in front‑end development. 308 | 309 | ### GNU 310 | 311 | - [GNU coding standards](https://www.gnu.org/prep/standards/) 312 | 313 | ### Java 314 | 315 | - [JavaEE Specification](https://github.com/javaee/javaee-spec) 316 | 317 | ### Linux 318 | 319 | - [Linux kernel coding style](https://www.kernel.org/doc/html/latest/process/coding-style.html) 320 | 321 | ### Mailchimp 322 | 323 | - [Mailchimp Content Style Guide](https://styleguide.mailchimp.com) 324 | 325 | ### Mozilla 326 | 327 | - [Mozilla Coding Style Guide](https://developer.mozilla.org/en-US/docs/MDN/Writing_guidelines/Writing_style_guide/Code_style_guide) 328 | 329 | ### Google 330 | 331 | - [Google-related developer documentation](https://developers.google.com/style) - This style guide provides editorial guidelines for writing clear and consistent Google-related developer documentation. 332 | 333 | ### Node.js 334 | 335 | - [Microsoft + Node.js Guidelines](https://github.com/Microsoft/nodejs-guidelines) 336 | - [Node.js Style Guide](https://github.com/felixge/node-style-guide) - A guide for styling your Node.js / JavaScript code. 337 | 338 | ### MongoDB 339 | 340 | - [Mongo Style Guide](https://github.com/jsoendermann/MongoStyleGuide) 341 | 342 | ### SQL 343 | 344 | - [SQL Style Guide](https://www.sqlstyle.guide) 345 | 346 | ### Other 347 | 348 | - [Keep a CHANGELOG](http://keepachangelog.com/en/0.3.0/) - Don't let your friends dump git logs into CHANGELOGs™. 349 | - [Project Guidelines](https://github.com/elsewhencode/project-guidelines) - A set of best practices for JavaScript projects. 350 | - [Semantic Versioning](http://semver.org) 351 | - [Indent style](https://en.wikipedia.org/wiki/Indentation_style) 352 | - [WebAppSec/Secure Coding Guidelines](https://wiki.mozilla.org/WebAppSec/Secure_Coding_Guidelines) 353 | - [Robot Framework User Guide](https://robotframework.org/robotframework/latest/RobotFrameworkUserGuide.html) 354 | - [CodeQL Coding Standards](https://github.com/github/codeql-coding-standards) 355 | 356 | ## Frameworks 357 | 358 | - [Symfony Coding Standards](https://symfony.com/doc/current/contributing/code/standards.html) 359 | - [Django Coding Style](https://docs.djangoproject.com/en/dev/internals/contributing/writing-code/coding-style) 360 | - [Vue Style Guide](https://vuejs.org/style-guide) 361 | - [Angular Style Guide](https://angular.dev/style-guide) 362 | 363 | ## Content Management System 364 | 365 | - [WordPress Coding Standards](https://developer.wordpress.org/coding-standards/wordpress-coding-standards/) 366 | - [Drupal Coding Standards](https://www.drupal.org/docs/develop/standards) 367 | - [Magento Coding Standards](https://developer.adobe.com/commerce/php/coding-standards/) 368 | - [Octobercms Developer Guide](https://octobercms.com/help/guidelines/developer) 369 | 370 | ## Tools 371 | 372 | - [Checkstyle](https://github.com/checkstyle/checkstyle) - Tool for checking Java source code for adherence to a Code Standard or set of validation rules. 373 | - [Conventional Changelog](https://github.com/conventional-changelog/conventional-changelog) 374 | - [EasyCodingStandard](https://github.com/easy-coding-standard/easy-coding-standard) - The Easiest Way to Use Any Coding Standard. 375 | - [ESLint](https://eslint.org/) - The pluggable linting utility for JavaScript and JSX. 376 | - [JavaScript Standard Style](https://standardjs.com) - One JavaScript Style to Rule Them All. 377 | - [Laravel Pint](https://laravel.com/docs/11.x/pint) - An opinionated PHP code style fixer for minimalists. 378 | - [North](http://pointnorth.io) - Design and development standards to align and guide your project. 379 | - [PHP_CodeSniffer](https://github.com/squizlabs/PHP_CodeSniffer) - The tool for detecting and fixing the violations of the specified standards in PHP code. 380 | - [PHP Coding Standards Fixer](https://cs.symfony.com) - The PHP Coding Standards Fixer (PHP CS Fixer) tool fixes your code to follow standards. 381 | - [RuboCop](https://rubocop.org) - A Ruby static code analyzer and formatter, based on the community Ruby style guide. 382 | - [semantic-release](https://github.com/semantic-release/semantic-release) 383 | - [ShellCheck](https://github.com/koalaman/shellcheck) - A shell script static analysis tool. 384 | -------------------------------------------------------------------------------- /assets/header.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/Kristories/awesome-guidelines/dc2c1f287ac293381cd3d469a4c92aaba2c05b0a/assets/header.png -------------------------------------------------------------------------------- /code-of-conduct.md: -------------------------------------------------------------------------------- 1 | # Contributor Covenant Code of Conduct 2 | 3 | ## Our Pledge 4 | 5 | In the interest of fostering an open and welcoming environment, we as 6 | contributors and maintainers pledge to making participation in our project and 7 | our community a harassment-free experience for everyone, regardless of age, body 8 | size, disability, ethnicity, gender identity and expression, level of experience, 9 | nationality, personal appearance, race, religion, or sexual identity and 10 | orientation. 11 | 12 | ## Our Standards 13 | 14 | Examples of behavior that contributes to creating a positive environment 15 | include: 16 | 17 | * Using welcoming and inclusive language 18 | * Being respectful of differing viewpoints and experiences 19 | * Gracefully accepting constructive criticism 20 | * Focusing on what is best for the community 21 | * Showing empathy towards other community members 22 | 23 | Examples of unacceptable behavior by participants include: 24 | 25 | * The use of sexualized language or imagery and unwelcome sexual attention or 26 | advances 27 | * Trolling, insulting/derogatory comments, and personal or political attacks 28 | * Public or private harassment 29 | * Publishing others' private information, such as a physical or electronic 30 | address, without explicit permission 31 | * Other conduct which could reasonably be considered inappropriate in a 32 | professional setting 33 | 34 | ## Our Responsibilities 35 | 36 | Project maintainers are responsible for clarifying the standards of acceptable 37 | behavior and are expected to take appropriate and fair corrective action in 38 | response to any instances of unacceptable behavior. 39 | 40 | Project maintainers have the right and responsibility to remove, edit, or 41 | reject comments, commits, code, wiki edits, issues, and other contributions 42 | that are not aligned to this Code of Conduct, or to ban temporarily or 43 | permanently any contributor for other behaviors that they deem inappropriate, 44 | threatening, offensive, or harmful. 45 | 46 | ## Scope 47 | 48 | This Code of Conduct applies both within project spaces and in public spaces 49 | when an individual is representing the project or its community. Examples of 50 | representing a project or community include using an official project e-mail 51 | address, posting via an official social media account, or acting as an appointed 52 | representative at an online or offline event. Representation of a project may be 53 | further defined and clarified by project maintainers. 54 | 55 | ## Enforcement 56 | 57 | Instances of abusive, harassing, or otherwise unacceptable behavior may be 58 | reported by contacting the project team at w.kristories@gmail.com. All 59 | complaints will be reviewed and investigated and will result in a response that 60 | is deemed necessary and appropriate to the circumstances. The project team is 61 | obligated to maintain confidentiality with regard to the reporter of an incident. 62 | Further details of specific enforcement policies may be posted separately. 63 | 64 | Project maintainers who do not follow or enforce the Code of Conduct in good 65 | faith may face temporary or permanent repercussions as determined by other 66 | members of the project's leadership. 67 | 68 | ## Attribution 69 | 70 | This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4, 71 | available at [http://contributor-covenant.org/version/1/4][version] 72 | 73 | [homepage]: http://contributor-covenant.org 74 | [version]: http://contributor-covenant.org/version/1/4/ 75 | -------------------------------------------------------------------------------- /contributing.md: -------------------------------------------------------------------------------- 1 | # Contributing to Awesome Guidelines 2 | 3 | Thank you for taking the time to contribute! :+1: 4 | 5 | ## How Can I Contribute? 6 | 7 | ### Creating Issues 8 | 9 | Know of an awesome guideline that’s missing from the list? If it’s not already mentioned in the [open issues](https://github.com/Kristories/awesome-guidelines/issues) or [pull requests](https://github.com/Kristories/awesome-guidelines/pulls), please feel free to create a new issue or submit a pull request. We’d love to hear from you! 10 | 11 | ### Submitting Pull Requests 12 | 13 | You’re welcome to work on any open issue. Just ensure you follow the contribution guidelines while submitting your PR. 14 | 15 | ### Voting and Commenting 16 | 17 | Join the conversation on GitHub Discussions ([Resource suggestions](https://github.com/Kristories/awesome-guidelines/discussions/categories/resource-suggestions)) to vote and provide feedback. 18 | 19 | ## Contribution Guidelines 20 | 21 | * Please search previous suggestions before making a new one, as yours may be a duplicate. 22 | * Use the following format: `[Title](url) - Description.` 23 | * The link should be the name of the package or project. 24 | * Links and categories should be sorted alphabetically. 25 | * Add one link per pull-request. 26 | * Keep descriptions concise, clear and simple, and end them with a period/stop. 27 | * Check your spelling and grammar. 28 | * New categories, or improvements to the existing ones are also welcome. 29 | * Make sure your text editor is set to remove trailing whitespace. 30 | 31 | ## Quality Standards 32 | 33 | Projects listed should meet these criteria to maintain quality: 34 | 35 | * Widely used and beneficial to the community. 36 | 37 | Thank you to all our [contributors](https://github.com/Kristories/awesome-guidelines/graphs/contributors)! This project wouldn’t be possible without your support. 38 | -------------------------------------------------------------------------------- /package.json: -------------------------------------------------------------------------------- 1 | { 2 | "scripts": { 3 | "test": "awesome-lint" 4 | }, 5 | "devDependencies": { 6 | "awesome-lint": "v1.2.0" 7 | } 8 | } 9 | -------------------------------------------------------------------------------- /test.js: -------------------------------------------------------------------------------- 1 | const awesomeLint = require('awesome-lint'); 2 | 3 | awesomeLint.report(); 4 | -------------------------------------------------------------------------------- /travis.yml: -------------------------------------------------------------------------------- 1 | language: node_js 2 | node_js: 3 | - 'node' 4 | # git: 5 | # depth: false 6 | --------------------------------------------------------------------------------