├── .github
    └── FUNDING.yml
├── README.md
├── cn
    ├── CHANGELOG.md
    ├── CODEBASE_STRUCTURE.md
    ├── CODE_OF_CONDUCT.md
    ├── CODING_GUIDELINES.md
    ├── CONTRIBUTING.md
    ├── ISSUE_TEMPLATES
    │   ├── bug_report.md
    │   ├── custom.md
    │   └── feature_request.md
    ├── PULL_REQUEST_TEMPLATE.md
    ├── README_TEMPLATES
    │   ├── Bot.md
    │   ├── Hackathon.md
    │   ├── IoT.md
    │   ├── Minimal.md
    │   ├── README.md
    │   └── Standard.md
    └── TODO.md
├── de
    ├── CHANGELOG.md
    ├── CODEBASE_STRUCTURE.md
    ├── CODE_OF_CONDUCT.md
    ├── CODING_GUIDELINES.md
    ├── CONTRIBUTING.md
    ├── ISSUE_TEMPLATES
    │   ├── bug_report.md
    │   ├── custom.md
    │   └── feature_request.md
    ├── PULL_REQUEST_TEMPLATE.md
    ├── README_TEMPLATES
    │   ├── Bot.md
    │   ├── Hackathon.md
    │   ├── IoT.md
    │   ├── Minimal.md
    │   ├── README.md
    │   └── Standard.md
    └── TODO.md
├── en
    ├── CHANGELOG.md
    ├── CODEBASE_STRUCTURE.md
    ├── CODE_OF_CONDUCT.md
    ├── CODING_GUIDELINES.md
    ├── CONTRIBUTING.md
    ├── ISSUE_TEMPLATES
    │   ├── bug_report.md
    │   ├── custom.md
    │   └── feature_request.md
    ├── PULL_REQUEST_TEMPLATE.md
    ├── README_TEMPLATES
    │   ├── Bot.md
    │   ├── Hackathon.md
    │   ├── IoT.md
    │   ├── Minimal.md
    │   ├── README.md
    │   └── Standard.md
    └── TODO.md
├── es
    ├── CHANGELOG.md
    ├── CODEBASE_STRUCTURE.md
    ├── CODE_OF_CONDUCT.md
    ├── CODING_GUIDELINES.md
    ├── CONTRIBUTING.md
    ├── ISSUE_TEMPLATES
    │   ├── bug_report.md
    │   ├── custom.md
    │   └── feature_request.md
    ├── PULL_REQUEST_TEMPLATE.md
    ├── README_TEMPLATES
    │   ├── Bot.md
    │   ├── Hackathon.md
    │   ├── IoT.md
    │   ├── Minimal.md
    │   ├── README.md
    │   └── Standard.md
    └── TODO.md
├── fr
    ├── CHANGELOG.md
    ├── CODEBASE_STRUCTURE.md
    ├── CODE_OF_CONDUCT.md
    ├── CODING_GUIDELINES.md
    ├── CONTRIBUTING.md
    ├── ISSUE_TEMPLATES
    │   ├── bug_report.md
    │   ├── custom.md
    │   └── feature_request.md
    ├── PULL_REQUEST_TEMPLATE.md
    ├── README_TEMPLATES
    │   ├── Bot.md
    │   ├── Hackathon.md
    │   ├── IoT.md
    │   ├── Minimal.md
    │   ├── README.md
    │   └── Standard.md
    └── TODO.md
├── hi
    ├── CHANGELOG.md
    ├── CODEBASE_STRUCTURE.md
    ├── CODE_OF_CONDUCT.md
    ├── CODING_GUIDELINES.md
    ├── CONTRIBUTING.md
    ├── ISSUE_TEMPLATES
    │   ├── bug_report.md
    │   ├── custom.md
    │   └── feature_request.md
    ├── PULL_REQUEST_TEMPLATE.md
    ├── README_TEMPLATES
    │   ├── Bot.md
    │   ├── Hackathon.md
    │   ├── IoT.md
    │   ├── Minimal.md
    │   ├── README.md
    │   └── Standard.md
    └── TODO.md
├── it
    ├── CHANGELOG.md
    ├── CODEBASE_STRUCTURE.md
    ├── CODE_OF_CONDUCT.md
    ├── CODING_GUIDELINES.md
    ├── CONTRIBUTING.md
    ├── ISSUE_TEMPLATES
    │   ├── bug_report.md
    │   ├── custom.md
    │   └── feature_request.md
    ├── PULL_REQUEST_TEMPLATE.md
    ├── README_TEMPLATES
    │   ├── Bot.md
    │   ├── Hackathon.md
    │   ├── IoT.md
    │   ├── Minimal.md
    │   ├── README.md
    │   └── Standard.md
    └── TODO.md
├── jp
    ├── CHANGELOG.md
    ├── CODEBASE_STRUCTURE.md
    ├── CODE_OF_CONDUCT.md
    ├── CODING_GUIDELINES.md
    ├── CONTRIBUTING.md
    ├── ISSUE_TEMPLATES
    │   ├── bug_report.md
    │   ├── custom.md
    │   └── feature_request.md
    ├── PULL_REQUEST_TEMPLATE.md
    ├── README_TEMPLATES
    │   ├── Bot.md
    │   ├── Hackathon.md
    │   ├── IoT.md
    │   ├── Minimal.md
    │   ├── README.md
    │   └── Standard.md
    └── TODO.md
├── ko
    ├── CHANGELOG.md
    ├── CODEBASE_STRUCTURE.md
    ├── CODE_OF_CONDUCT.md
    ├── CODING_GUIDELINES.md
    ├── CONTRIBUTING.md
    ├── ISSUE_TEMPLATES
    │   ├── bug_report.md
    │   ├── custom.md
    │   └── feature_request.md
    ├── PULL_REQUEST_TEMPLATE.md
    ├── README_TEMPLATES
    │   ├── Bot.md
    │   ├── Hackathon.md
    │   ├── IoT.md
    │   ├── Minimal.md
    │   ├── README.md
    │   └── Standard.md
    └── TODO.md
├── pt
    ├── CHANGELOG.md
    ├── CODEBASE_STRUCTURE.md
    ├── CODE_OF_CONDUCT.md
    ├── CODING_GUIDELINES.md
    ├── CONTRIBUTING.md
    ├── ISSUE_TEMPLATES
    │   ├── bug_report.md
    │   ├── custom.md
    │   └── feature_request.md
    ├── PULL_REQUEST_TEMPLATE.md
    ├── README_TEMPLATES
    │   ├── Bot.md
    │   ├── Hackathon.md
    │   ├── IoT.md
    │   ├── Minimal.md
    │   ├── README.md
    │   └── Standard.md
    └── TODO.md
└── ru
    ├── CHANGELOG.md
    ├── CODEBASE_STRUCTURE.md
    ├── CODE_OF_CONDUCT.md
    ├── CODING_GUIDELINES.md
    ├── CONTRIBUTING.md
    ├── ISSUE_TEMPLATES
        ├── bug_report.md
        ├── custom.md
        └── feature_request.md
    ├── PULL_REQUEST_TEMPLATE.md
    ├── README_TEMPLATES
        ├── Bot.md
        ├── Hackathon.md
        ├── IoT.md
        ├── Minimal.md
        ├── README.md
        └── Standard.md
    └── TODO.md


/.github/FUNDING.yml:
--------------------------------------------------------------------------------
1 | # These are supported funding model platforms
2 | 
3 | # custom: https://www.paypal.me/kylelobo/
4 | # patreon: kylelobo
5 | 


--------------------------------------------------------------------------------
/README.md:
--------------------------------------------------------------------------------
  1 | <p align="center">
  2 |  <img src="https://i.imgur.com/rSyq3MW.png" alt="The Documentation Compendium"></a>
  3 | </p>
  4 | 
  5 | <h3 align="center">The Documentation Compendium</h3>
  6 | 
  7 | <div align="center">
  8 | 
  9 |   [![Tweet](https://img.shields.io/twitter/url/https/shields.io.svg?style=social)](https://twitter.com/intent/tweet?text=%F0%9F%93%A2%20Various%20README%20templates%20and%20tips%20on%20writing%20high-quality%20documentation%20that%20people%20want%20to%20read.&url=https://github.com/kylelobo/The-Documentation-Compendium)
 10 |   [![Status](https://img.shields.io/badge/status-active-success.svg)]()
 11 |   [![GitHub Issues](https://img.shields.io/github/issues/kylelobo/The-Documentation-Compendium.svg)](https://github.com/kylelobo/The-Documentation-Compendium/issues)
 12 |   [![GitHub Pull Requests](https://img.shields.io/github/issues-pr/kylelobo/The-Documentation-Compendium.svg)](https://github.com/kylelobo/The-Documentation-Compendium/pulls)
 13 |   [![License](https://img.shields.io/badge/license-CC0-blue.svg)](http://creativecommons.org/publicdomain/zero/1.0/)
 14 | 
 15 | <!--   <a href="https://www.producthunt.com/posts/the-documentation-compendium?utm_source=badge-top-post-badge&utm_medium=badge&utm_souce=badge-the-documentation-compendium" target="_blank"><img src="https://api.producthunt.com/widgets/embed-image/v1/top-post-badge.svg?post_id=157965&theme=dark&period=daily" alt="The Documentation Compendium - Beautiful README templates that people want to read. | Product Hunt Embed" style="width: 250px; height: 54px;" width="250px" height="54px" /></a> -->
 16 | 
 17 | </div>
 18 | 
 19 | ---
 20 | 
 21 | <p align = "center">💡 Various templates & tips on writing high-quality documentation that people want to read.</p>
 22 | 
 23 | 
 24 | ## Table of Contents
 25 | 
 26 | - [Why must you document your project](#why_document)
 27 | - [Best Practices](#best_practices)
 28 | - [Templates](#templates)
 29 | - [The Art of Technical Writing](#art)
 30 |   - [Novice Technical Writers](https://www.writethedocs.org/guide/#new-to-caring-about-documentation)
 31 |   - [Experienced Technical Writers](https://www.writethedocs.org/guide/#experienced-documentarian)
 32 |   - [API Documentation](https://www.writethedocs.org/guide/#api-documentation)
 33 |   - [Adding badges](https://github.com/badges/shields/blob/master/README.md#examples)
 34 |   - [Tools](https://www.writethedocs.org/guide/#tools-of-the-trade)
 35 | - [Technical Writer Programs](#programs)
 36 | - [Awesome Technical Writing Sources](#sources)
 37 | - [Get Feedback](#feedback)
 38 | - [Acknowledgements](#acknowledgements)
 39 | 
 40 | 
 41 | ## Why must you document your project? <a name = "why_document"></a>
 42 | 
 43 | - It doesn’t matter how good your software is, because if the documentation is not good enough, people will not use it.
 44 | Even if for some reason they have to use it, without good documentation, they won’t use it effectively or the way you’d like them to
 45 | - THE MAJORITY OF PEOPLE GLANCE AND LEAVE. Make it pretty so that it's easier for them to star before they leave. The more stars you have, the likelier it is that serious developers will use your repo
 46 | - You will be using your code in 6 months. Code that you wrote 6 months ago is often indistinguishable from code that someone else has written
 47 | - You want people to use your code because you think that others might find it useful. However, people need to understand why your code might be useful for them, before they decide to use it
 48 | - You want people to help out. If you don’t have documentation, you will miss out on a whole class of contributors
 49 | - You want to be a better writer
 50 | 
 51 | 
 52 | ## Best Practices<a name = "best_practices"></a>
 53 | 
 54 | **Things to remember:**
 55 | 
 56 | - Keep a lighthearted friendly tone. Treat the reader as someone who doesn't have a lot of knowledge about the topic but is very interested
 57 | - Keep things brief
 58 | - Use headings frequently. This breaks things up when reading and often it is good for linking to specific information
 59 | - Link to other places in the documentation often but only for additional information. Readers should not have to navigate through several pages to find information regarding one specific thing. Just inline the immediately relevant information and link off if they want to know more
 60 | - Use as many code snippets, CLI, etc. examples as possible. Show the reader what you mean
 61 | - Gently introduce a guide before diving into technical details. This gives context and readers are more likely to stay engaged longer
 62 | - It is always good to describe the functionality of the various files in your project
 63 | - Always use gender-neutral pronouns. A gender-neutral pronoun is a pronoun which does not associate a gender with the individual who is being discussed. For eg. - using 'they' instead of 'he/she'
 64 | 
 65 | **Things you should avoid:**
 66 | 
 67 | - Don't assume prior knowledge about the topic. If you want to appeal to a large audience, then you are going to have people with very diverse backgrounds
 68 | - Don't use idioms. Write using more formal terms that are well defined. This makes it easier for non-native English speakers and for translations to be written
 69 | - Don't clutter explanations with overly detailed examples
 70 | - Don't use terms that are offensive to any group. There will never be a good reason to
 71 | 
 72 | 
 73 | ## Templates <a name = "templates"></a>
 74 | 
 75 | - [README](/en/README_TEMPLATES)
 76 | - [Pull Request](/en/PULL_REQUEST_TEMPLATE.md)
 77 | - [Issues](/en/ISSUE_TEMPLATES)
 78 | - [Contributing](/en/CONTRIBUTING.md)
 79 | - [Code of Conduct](/en/CODE_OF_CONDUCT.md)
 80 | - [Coding Guidelines](/en/CODING_GUIDELINES.md)
 81 | - [Codebase Structure](/en/CODEBASE_STRUCTURE.md)
 82 | - [Changelog](/en/CHANGELOG.md)
 83 | - [TODO](/en/TODO.md)
 84 | 
 85 | 
 86 | ## The Art of Technical Writing <a name = "art"></a>
 87 | 
 88 | Further reading on technical writing topics from [www.writethedocs.org](https://www.writethedocs.org)
 89 | 
 90 | - [Novice Technical Writers](https://www.writethedocs.org/guide/#new-to-caring-about-documentation)
 91 | - [Experienced Technical Writers](https://www.writethedocs.org/guide/#experienced-documentarian)
 92 | - [API Documentation](https://www.writethedocs.org/guide/#api-documentation)
 93 | - [Adding badges](https://github.com/badges/shields/blob/master/README.md#examples)
 94 | - [Tools](https://www.writethedocs.org/guide/#tools-of-the-trade)
 95 | 
 96 | 
 97 | ## Technical Writing Programs <a name = "programs"></a>
 98 | 
 99 | 1. [Google Season of Docs](https://developers.google.com/season-of-docs/)
100 | 2. [A List of Open Source Projects with Volunteer Documentation Opportunities](https://www.reddit.com/r/technicalwriting/comments/800a9a/a_list_of_open_source_projects_with_volunteer/)
101 | 
102 | 
103 | ## Awesome Technical Writing Sources <a name = "sources"></a>
104 | 
105 | 1. [r/technicalwriting](https://www.reddit.com/r/technicalwriting/)
106 | 2. [My Tech Writing Process](https://amrutaranade.com/2018/03/07/my-writing-process/) - Amruta Ranade
107 | 3. [Developer to Technical Writer](https://www.reddit.com/r/technicalwriting/comments/a1x6c8/) - r/technicalwriting
108 | 4. [awesome-github-templates](https://github.com/devspace/awesome-github-templates) - devspace
109 | 5. [makeareadme](https://www.makeareadme.com/) - dguo
110 | 6. [What nobody tells you about documentation](https://www.divio.com/blog/documentation/) - Daniele Procida
111 | 7. [3 Essential Components of Great Documentation](https://dev.to/eli/3-essential-components-of-great-documentation-2cih) - Eli B
112 | 8. [Inspiring techies to become great writers](http://cameronshorter.blogspot.com/2019/02/inspiring-techies-to-become-great.html) - Cameron Shorter
113 | 9. [Technical Documentation Writing Principles](http://cameronshorter.blogspot.com/2018/06/technical-documentation-writing.html) - Cameron Shorter
114 | 10. [Building Our Documentation Site on platformOS — Part 2: Content Production and Layouts](https://www.platformos.com/blog/post/blog/building-our-documentation-site-on-platformos-part-2-content-production-and-layouts) - Diana Lakato
115 | 11. [Google Developer Documentation Style Guide](https://developers.google.com/style/) - Google
116 | 12. [README Maturity Model](https://github.com/LappleApple/feedmereadmes/blob/master/README-maturity-model.md) - LappleApple
117 | 13. [Markdown Style Guide](http://www.cirosantilli.com/markdown-style-guide/) - Ciro Santilli
118 | 
119 | 
120 | ## Get Feedback <a name = "feedback"></a>
121 | 
122 | - [feedmereadmes](https://github.com/LappleApple/feedmereadmes) - Free README editing + feedback to make your open-source projects grow. See the README maturity model to help you keep going
123 | - [maintainer.io](https://maintainer.io/) - Free README standardization and feedback if you click on 'Book an audit'
124 | 
125 | 
126 | ## Acknowledgements <a name = "acknowledgements"></a>
127 | 
128 | 1. [Documenting your projects on GitHub](https://guides.github.com/features/wikis/) - GitHub Guides
129 | 2. [documentation-handbook](https://github.com/jamiebuilds/documentation-handbook) - jamiebuilds
130 | 3. [Documentation Guide](https://www.writethedocs.org/guide/) - Write the Docs
131 | 
132 | 
133 | ## P.S. <a name = "ps"></a>
134 | 
135 | - This repo is under active development. If you have any improvements / suggestions please file an [issue](https://github.com/kylelobo/The-Documentation-Compendium/issues/new/choose) or send in a [Pull Request](/en/CONTRIBUTING.md)
136 | - The [issues](https://github.com/kylelobo/The-Documentation-Compendium/issues) page is a good place to visit if you want to pick up some task. It has a list of things that are to be implemented in the near future
137 | 
138 | 
139 | <p xmlns:dct="http://purl.org/dc/terms/" xmlns:vcard="http://www.w3.org/2001/vcard-rdf/3.0#">
140 |   <a rel="license"
141 |      href="http://creativecommons.org/publicdomain/zero/1.0/">
142 |     <img src="http://i.creativecommons.org/p/zero/1.0/88x31.png" style="border-style: none;" alt="CC0" />
143 |   </a>
144 |   <br />
145 |   To the extent possible under law,
146 |   <a rel="dct:publisher"
147 |      href="https://github.com/kylelobo/">
148 |     <span property="dct:title">Kyle Lobo</span></a>
149 |   has waived all copyright and related or neighboring rights to
150 |   <span property="dct:title">The Documentation Compendium</span>.
151 | </p>
152 | 


--------------------------------------------------------------------------------
/cn/CHANGELOG.md:
--------------------------------------------------------------------------------
 1 | # 变更日志
 2 | 该项目的显著变更都将记录在该文档中。
 3 | 
 4 | 格式遵照 [Keep a Changelog](http://keepachangelog.com/)
 5 | 该项目遵循 [Semantic Versioning](http://semver.org/).
 6 |  
 7 | ## [尚未发布] - yyyy-mm-dd
 8 |  
 9 | 在此我们为品牌写升级说明。此处为团队合作，尽量使说明简单明了。
10 |  
11 | ### 新增
12 | - [项目名称-XXXX](http://tickets.projectname.com/browse/PROJECTNAME-XXXX)
13 |   MINOR Ticket title goes here.
14 | - [项目名称-YYYY](http://tickets.projectname.com/browse/PROJECTNAME-YYYY)
15 |   PATCH Ticket title goes here.
16 |  
17 | ### 更改
18 |  
19 | ### 修复
20 |  
21 | ## [1.2.4] - 2017-03-15
22 |   
23 | 此处我们可以提供1.2.4的更新步骤供大家参考。
24 |  
25 | ### 新增
26 |  
27 | ### 更改
28 |   
29 | - [项目名称-ZZZZ](http://tickets.projectname.com/browse/PROJECTNAME-ZZZZ)
30 |   现在 PATCH Drupal.org 用于创作人。
31 |  
32 | ### 修复
33 |  
34 | - [项目名称-TTTT](http://tickets.projectname.com/browse/PROJECTNAME-TTTT)
35 |   PATCH 为 runsheet teaser 删除添加逻辑，以删除相应的计划卡。
36 |  
37 | ## [1.2.3] - 2017-03-14
38 |  
39 | ### 新增
40 |    
41 | ### 更改
42 |  
43 | ### 修复
44 |  
45 | - [项目名称-UUUU](http://tickets.projectname.com/browse/PROJECTNAME-UUUU)
46 |   MINOR Fix module foo tests
47 | - [项目名称-RRRR](http://tickets.projectname.com/browse/PROJECTNAME-RRRR)
48 |   MAJOR Module foo's timeline uses the browser timezone for date resolution 
49 | 


--------------------------------------------------------------------------------
/cn/CODEBASE_STRUCTURE.md:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/race2infinity/The-Documentation-Compendium/272376ad2dfb2907b083990b3ef6a16af514ec48/cn/CODEBASE_STRUCTURE.md


--------------------------------------------------------------------------------
/cn/CODE_OF_CONDUCT.md:
--------------------------------------------------------------------------------
 1 | # 参与者公约
 2 | 
 3 | 
 4 | ## 我们的承诺
 5 | 
 6 | 为建设开放友好的环境，我们贡献者和维护者承诺：不论年龄、体型、身体健全与否、民族、性征、性别认同与表征、经验水平、教育程度、社会地位、国籍、相貌、种族、信仰、性取向，我们项目和社区的参与者皆免于骚扰。
 7 | 
 8 | ## 我们的准则
 9 | 
10 | 有助于创造积极环境的行为包括但不限于：
11 | 
12 | * 措辞友好且包容
13 | * 尊重不同的观点和经验
14 | * 耐心接受有益批评
15 | * 关注对社区最有利的事情
16 | * 与社区其他成员友善相处
17 | 
18 | 参与者不应采取的行为包括但不限于：
19 | 
20 | * 发布与性有关的言论或图像、不受欢迎地献殷勤
21 | * 捣乱/煽动/造谣行为、侮辱/贬损的评论、人身及政治攻击
22 | * 公开或私下骚扰
23 | * 未经明确授权便发布他人的资料，如住址、电子邮箱等
24 | * 其他有理由认定为违反职业操守的不当行为
25 | 
26 | ## 我们的义务
27 | 
28 | 项目维护者有义务诠释何谓“妥当行为”，并妥善公正地纠正已发生的不当行为。
29 | 
30 | 项目维护者有权利和义务去删除、编辑、拒绝违背本行为标准的评论（comments）、提交（commits）、代码、wiki 编辑、问题（issues）等贡献；项目维护者可暂时或永久地封禁任何他们认为行为不当、威胁、冒犯、有害的参与者。
31 | 
32 | ## 适用范围
33 | 
34 | 本行为标准适用于本项目。当有人代表本项目或本社区时，本标准亦适用于此人所处的公共平台。
35 | 
36 | 代表本项目或本社区的情形包括但不限于：使用项目的官方电子邮件、通过官方媒体账号发布消息、作为指定代表参与在线或线下活动等。
37 | 
38 | 代表本项目的行为可由项目维护者进一步定义及解释。
39 | 
40 | ## 贯彻落实
41 | 
42 | 可以致信[在此输入EMAIL]，向项目团队举报滥用、骚扰及不当行为。
43 | 
44 | 维护团队将审议并调查全部投诉，妥善地予以必要的回应。项目团队有义务保密举报者信息。具体执行方针或将另行发布。
45 | 
46 | 未切实遵守或执行本行为标准的项目维护人员，经项目负责人或其他成员决议，可能被暂时或永久地剥夺参与本项目的资格。
47 | 
48 | ## 来源
49 | 
50 | 本行为标准改编自[参与者公约][主页]，版本 1.4
51 | 可在此查阅：https://www.contributor-covenant.org/zh-cn/version/1/4/code-of-conduct.html
52 | 
53 | [主页]: https://www.contributor-covenant.org
54 | 


--------------------------------------------------------------------------------
/cn/CODING_GUIDELINES.md:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/race2infinity/The-Documentation-Compendium/272376ad2dfb2907b083990b3ef6a16af514ec48/cn/CODING_GUIDELINES.md


--------------------------------------------------------------------------------
/cn/CONTRIBUTING.md:
--------------------------------------------------------------------------------
 1 | # 参与指南
 2 | 
 3 | - 参与 The Documentation Compendium 项目很简单，本文档教你快速上手。
 4 | 
 5 | ## General
 6 | - 请参照 [Codebase Structure](./CODEBASE_STRUCTURE.md) 了解本项目的文档结构。
 7 | - 请确保你做的每一项更符合本 repo 的 [Coding Guidelines](./CODING_GUIDELINES.md)。
 8 | ## 提交更改
 9 | 
10 | - Fork the repo
11 |   - <https://github.com/kylelobo/The-Documentation-Compendium/fork>
12 | - Check out a new branch based and name it to what you intend to do:
13 |   - Example:
14 |     ````
15 |     $ git checkout -b BRANCH_NAME
16 |     ````
17 |     If you get an error, you may need to fetch fooBar first by using
18 |     ````
19 |     $ git remote update && git fetch
20 |     ````
21 |   - Use one branch per fix / feature
22 | - Commit 你的更改
23 |   - 请提供 git message 解释你做了什么
24 |   - 请确保你的commit messages 遵循这一[conventions](https://gist.github.com/robertpainsi/b632364184e70900af4ab688decf6f53#file-commit-message-guidelines-md)
25 |   - Commit to the forked repository
26 |   - 示例:
27 |     ````
28 |     $ git commit -am 'Add some fooBar'
29 |     ````
30 | - Push to the branch
31 |   - Example:
32 |     ````
33 |     $ git push origin BRANCH_NAME
34 |     ````
35 | - Make a pull request
36 |   - Make sure you send the PR to the <code>fooBar</code> branch
37 |   - Travis CI is watching you!
38 | 
39 | 如果你遵循以上步骤，你的PR将会顺利被合并到main repo 中。
40 | 
41 | 


--------------------------------------------------------------------------------
/cn/ISSUE_TEMPLATES/bug_report.md:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/race2infinity/The-Documentation-Compendium/272376ad2dfb2907b083990b3ef6a16af514ec48/cn/ISSUE_TEMPLATES/bug_report.md


--------------------------------------------------------------------------------
/cn/ISSUE_TEMPLATES/custom.md:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/race2infinity/The-Documentation-Compendium/272376ad2dfb2907b083990b3ef6a16af514ec48/cn/ISSUE_TEMPLATES/custom.md


--------------------------------------------------------------------------------
/cn/ISSUE_TEMPLATES/feature_request.md:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/race2infinity/The-Documentation-Compendium/272376ad2dfb2907b083990b3ef6a16af514ec48/cn/ISSUE_TEMPLATES/feature_request.md


--------------------------------------------------------------------------------
/cn/PULL_REQUEST_TEMPLATE.md:
--------------------------------------------------------------------------------
 1 | ### Pull request 检查清单
 2 | 🚨 请参照本repository [guidelines for contributing](./CONTRIBUTING.md).
 3 | 
 4 | - [ ] 请确保你从 **topic/feature/bugfix branch** (右手边)创建pull request. 请勿从master branch 创建pr.
 5 | - [ ] 请确保你的pull request 针对 **fooBar branch** (左手边).
 6 | - [ ] 检查commit 信息风格是否相符。
 7 | - [ ] 你的代码能通过单元测试或代码提示检查。
 8 | 
 9 | ### 描述
10 | 请描述你的pull request.
11 | 
12 | ❤️ 感谢!
13 | 


--------------------------------------------------------------------------------
/cn/README_TEMPLATES/Bot.md:
--------------------------------------------------------------------------------
  1 | <p align="center">
  2 |   <a href="" rel="noopener">
  3 |  <img width=200px height=200px src="https://i.imgur.com/FxL5qM0.jpg" alt="Bot logo"></a>
  4 | </p>
  5 | 
  6 | <h3 align="center">机器人姓名</h3>
  7 | 
  8 | <div align="center">
  9 | 
 10 |   [![Status](https://img.shields.io/badge/status-active-success.svg)]()
 11 |   [![Platform](https://img.shields.io/badge/platform-reddit-orange.svg)](https://www.reddit.com/user/Wordbook_Bot)
 12 |   [![GitHub Issues](https://img.shields.io/github/issues/kylelobo/The-Documentation-Compendium.svg)](https://github.com/kylelobo/The-Documentation-Compendium/issues)
 13 |   [![GitHub Pull Requests](https://img.shields.io/github/issues-pr/kylelobo/The-Documentation-Compendium.svg)](https://github.com/kylelobo/The-Documentation-Compendium/pulls)
 14 |   [![License](https://img.shields.io/badge/license-MIT-blue.svg)](/LICENSE)
 15 | 
 16 | </div>
 17 | 
 18 | ---
 19 | 
 20 | <p align="center"> 🤖 用几句话描述你的机器人做什么<br> 
 21 | </p>
 22 | 
 23 | ## 📝 目录
 24 | + [简介](#about)
 25 | + [演示](#demo)
 26 | + [原理](#working)
 27 | + [用法](#usage)
 28 | + [快速上手](#getting_started)
 29 | + [部署你的机器人](#deployment)
 30 | + [技术支持](#built_using)
 31 | + [待做](../TODO.md)
 32 | + [贡献](../CONTRIBUTING.md)
 33 | + [作者](#authors)
 34 | + [致谢](#acknowledgement)
 35 | 
 36 | ## 🧐 简介 <a name = "about"></a>
 37 | 用 1-2 个段落描述该机器人的用途。
 38 | 
 39 | ## 🎥 演示 <a name = "demo"></a>
 40 | ![Working](https://media.giphy.com/media/20NLMBm0BkUOwNljwv/giphy.gif)
 41 | 
 42 | ## 💭 原理 <a name = "working"></a>
 43 | 
 44 | 
 45 | 该机器人首先从评论中提取单词，然后从牛津词典 API 中获取单词的定义、语篇、例子和来源。如果该词在牛津词典中不存在，牛津词典的API 会返回一个 404 响应，机器人便会尝试从 Urban Dictionary 的 API 中获取结果。
 46 | 该机器人使用 Pushshift API 来获取评论，使用 PRAW 模块来回复评论，使用 Heroku 作为服务器。它用 Python 3.6 编写。
 47 | 
 48 | ## 🎈 用法 <a name = "usage"></a>
 49 | 
 50 | 使用该机器人，键入：
 51 | ```
 52 | !dict word
 53 | ```
 54 | 指令的第一部分，如 "!dict" 对大小写**不**敏感。
 55 | 机器人会给你牛津词典（或 Urban Dictionary；如果该词不存在于牛津词典中）的定义作为评论回复。
 56 | 
 57 | ### 示例:
 58 | 
 59 | > !dict what is love
 60 | 
 61 | **定义:**
 62 | 
 63 | Baby, dont hurt me~
 64 | Dont hurt me~ no more.
 65 | 
 66 | **示例:**
 67 | 
 68 | Dude1: Bruh, what is love?
 69 | Dude2: Baby, dont hurt me, dont hurt me- no more!
 70 | Dude1: dafuq?
 71 | 
 72 | **来源:** https://www.urbandictionary.com/define.php?term=what%20is%20love
 73 | 
 74 | ---
 75 | 
 76 | <sup>Beep boop. I am a bot. If there are any issues, contact my [Master](https://www.reddit.com/message/compose/?to=PositivePlayer1&subject=/u/Wordbook_Bot)</sup>
 77 | 
 78 | <sup>Want to make a similar reddit bot? Check out: [GitHub](https://github.com/kylelobo/Reddit-Bot)</sup>
 79 | 
 80 | ## 🏁 快速上手 <a name = "getting_started"></a>
 81 | 
 82 | 遵循以下指引，你将在本地机器上建立并运行项目副本用于开发和测试目的。参见[deployment](#deployment)了解如何在实时系统上部署项目的注意事项。
 83 | 
 84 | ### 先决条件
 85 | 你需要哪些软件及如何安装它们。
 86 | 
 87 | ```
 88 | 举个例子
 89 | ```
 90 | 
 91 | ### 安装
 92 | 
 93 | 手把手教你如何让运行开发环境。
 94 | 介绍每一步都是什么
 95 | 
 96 | ```
 97 | 举个例子
 98 | ```
 99 | 
100 | 重复以上
101 | 
102 | ```
103 | 直到结束
104 | ```
105 | 
106 | 最后用从系统中获取的一些数据来举例，或者用它来做一个小演示。
107 | 
108 | ## 🚀 部署你的机器人 <a name = "deployment"></a>
109 | 
110 |  参见我的配置查看如何部署机器人的项目示例。
111 | + **Heroku**: https://github.com/kylelobo/Reddit-Bot#deploying_the_bot
112 | 
113 | ## ⛏️ 技术支持 <a name = "built_using"></a>
114 | + [PRAW](https://praw.readthedocs.io/en/latest/) - Python Reddit API Wrapper
115 | + [Heroku](https://www.heroku.com/) - SaaS hosting platform
116 | 
117 | ## ✍️ 作者 <a name = "authors"></a>
118 | + [@kylelobo](https://github.com/kylelobo) - 构想&初步工作
119 | 
120 | 另请参见参与本项目的[贡献者](https://github.com/kylelobo/The-Documentation-Compendium/contributors)名单。
121 | 
122 | ## 🎉 致谢 <a name = "acknowledgement"></a>
123 | + 向任何使用其代码的人致意
124 | + 灵感来源
125 | + 参考文献


--------------------------------------------------------------------------------
/cn/README_TEMPLATES/Hackathon.md:
--------------------------------------------------------------------------------
  1 | <p align="center">
  2 |   <a href="" rel="noopener">
  3 |  <img src="https://i.imgur.com/AZ2iWek.png" alt="Project logo"></a>
  4 | </p>
  5 | <h3 align="center">项目标题</h3>
  6 | 
  7 | <div align="center">
  8 | 
  9 |   [![Hackathon](https://img.shields.io/badge/hackathon-name-orange.svg)](http://hackathon.url.com) 
 10 |   [![Status](https://img.shields.io/badge/status-active-success.svg)]() 
 11 |   [![GitHub Issues](https://img.shields.io/github/issues/kylelobo/The-Documentation-Compendium.svg)](https://github.com/kylelobo/The-Documentation-Compendium/issues)
 12 |   [![GitHub Pull Requests](https://img.shields.io/github/issues-pr/kylelobo/The-Documentation-Compendium.svg)](https://github.com/kylelobo/The-Documentation-Compendium/pulls)
 13 |   [![License](https://img.shields.io/badge/license-MIT-blue.svg)](LICENSE.md)
 14 | 
 15 | </div>
 16 | 
 17 | ---
 18 | 
 19 | <p align="center"> 几句话描述你的项目
 20 |     <br> 
 21 | </p>
 22 | 
 23 | ## 📝 目录
 24 | - [问题陈述](#problem_statement)
 25 | - [构想/解决方案](#idea)
 26 | - [Dependencies / 限制因素](#limitations)
 27 | - [今后工作范围](#future_scope)
 28 | - [快速上手](#getting_started)
 29 | - [用法](#usage)
 30 | - [技术栈](#tech_stack)
 31 | - [贡献](../CONTRIBUTING.md)
 32 | - [作者](#authors)
 33 | - [致谢](#acknowledgments)
 34 | 
 35 | ## 🧐 问题陈述 <a name = "problem_statement"></a>
 36 | 在撰写问题陈述时，建议遵循特定设计范式。下面是一个商业分析领域常用的简明模板，旨在将焦点放在定义问题上。
 37 | 
 38 | - 理想状态：这一部分用来描述产品或程序的理想状态。总体而言，这一部分应说明一旦实施解决方案后的预期环境。
 39 | - 现状：该部分用于描述程序或产品现状。
 40 | - 后果：这一部分用来描述如果问题没有得到解决或改进，对企业的影响。这包括金钱、时间、生产力、竞争优势等成本。
 41 | 
 42 | 遵循这一范式将产出一个可行文件，可以用来理解问题并引出需求，从而获得一个成功的解决方案。
 43 | 
 44 | ## 💡 构想/解决方案 <a name = "idea"></a>
 45 | 本节用于描述潜在的解决方案。一旦完成并理解理想状态、现状和后果部分，提供解决方案就会更容易。
 46 | 
 47 | ## ⛓️ Dependencies / 限制因素 <a name = "limitations"></a>
 48 | - 你的项目有哪些dependencies？
 49 | - 用详细简明的语言描述每个限制因素
 50 | - 解释每个限制因素存在的原因
 51 | - 解释为何所选择方法无法克服每个限制因素
 52 | - 评估每个限制因素对你项目的整体结果和结论的影响。适当时，描述这些限制如何导向进一步研究的需要。
 53 | 
 54 | ## 🚀 今后工作范围 <a name = "future_scope"></a>
 55 | 写下你在黑客马拉松中无法开发的内容，及你的项目在未来可以实现的目标。
 56 | 
 57 | ## 🏁 快速上手 <a name = "getting_started"></a>
 58 | 遵循以下指引，你将在本地机器上建立并运行项目副本用于开发和测试目的。参见[deployment](#deployment)了解如何在实时系统上部署项目的注意事项。
 59 | 
 60 | ### 先决条件
 61 | 你需要哪些软件及如何安装它们。
 62 | 
 63 | ```
 64 | 举个例子
 65 | ```
 66 | 
 67 | ### 安装
 68 | 
 69 | 手把手教你如何让运行开发环境。
 70 | 介绍每一步都是什么
 71 | 
 72 | ```
 73 | 举个例子
 74 | ```
 75 | 
 76 | 重复以上
 77 | 
 78 | ```
 79 | 直到结束
 80 | ```
 81 | 
 82 | 
 83 | ## 🎈 用法 <a name="usage"></a>
 84 | 添加关于如何使用该系统的说明。
 85 | 
 86 | 
 87 | ## ⛏️ 技术栈 <a name = "tech_stack"></a>
 88 | - [MongoDB](https://www.mongodb.com/) - Database
 89 | - [Express](https://expressjs.com/) - Server Framework
 90 | - [VueJs](https://vuejs.org/) - Web Framework
 91 | - [NodeJs](https://nodejs.org/en/) - Server Environment
 92 | 
 93 | ## ✍️ 作者 <a name = "authors"></a>
 94 | + [@kylelobo](https://github.com/kylelobo) - 构想&初步工作
 95 | 
 96 | 、、、、、、
 97 | 
 98 | ## 🎉 致谢 <a name = "acknowledgement"></a>
 99 | + 向任何使用其代码的人致意
100 | + 灵感来源
101 | + 参考文献


--------------------------------------------------------------------------------
/cn/README_TEMPLATES/IoT.md:
--------------------------------------------------------------------------------
1 | TODO
2 | 


--------------------------------------------------------------------------------
/cn/README_TEMPLATES/Minimal.md:
--------------------------------------------------------------------------------
 1 | # 项目名称
 2 | 
 3 | ## 目录
 4 | + [关于](#about)
 5 | + [快速开始](#getting_started)
 6 | + [使用方法](#usage)
 7 | + [贡献](../CONTRIBUTING.md)
 8 | 
 9 | ## 关于 <a name = "about"></a>
10 | 关于你项目的目的，写1-2个段落。
11 | 
12 | ## 快速开始 <a name = "getting_started"></a>
13 | 这些指令会让你复制整个项目，并在本地机器上运行以进行开发和测试。
14 | 查看[部署](#deployment)，获取如何在线上系统部署的信息。
15 | 
16 | ### 准备工作
17 | 
18 | 需要哪些软件以及如何安装它们。
19 | 
20 | ```
21 | 例子
22 | ```
23 | 
24 | ### 安装
25 | 
26 | 一步步的介绍如何运行开发环境。
27 | 
28 | 介绍每个步骤
29 | 
30 | ```
31 | 给出例子
32 | ```
33 | 
34 | 然后重复
35 | 
36 | ```
37 | 直到完成
38 | ```
39 | 
40 | 在例子最后，从搭好的系统中获取一些数据，或者介绍如何使用它做个小的demo展示。
41 | 
42 | ## 使用方法 <a name = "usage"></a>
43 | 
44 | 介绍如何使用这个系统。
45 | 


--------------------------------------------------------------------------------
/cn/README_TEMPLATES/README.md:
--------------------------------------------------------------------------------
1 | ### 这个文件夹包括了一些README的模板，可根据你的项目类型选择。
2 | 
3 | 1. [Bot.md](/README%20Templates/Bot.md) - 
4 | 2. [Hackathon.md](/README%20Templates/Hackathon.md) - 
5 | 3. [IoT.md](/README%20Templates/IoT.md) - 
6 | 4. [Minimal.md](/README%20Templates/Minimal.md) - 
7 | 5. [Standard.md](/README%20Templates/Standard.md) - 
8 | 


--------------------------------------------------------------------------------
/cn/README_TEMPLATES/Standard.md:
--------------------------------------------------------------------------------
  1 | <p align="center">
  2 |   <a href="" rel="noopener">
  3 |  <img width=200px height=200px src="https://i.imgur.com/6wj0hh6.jpg" alt="Project logo"></a>
  4 | </p>
  5 | 
  6 | <h3 align="center">项目名称</h3>
  7 | 
  8 | <div align="center">
  9 | 
 10 |   [![Status](https://img.shields.io/badge/status-active-success.svg)]() 
 11 |   [![GitHub Issues](https://img.shields.io/github/issues/kylelobo/The-Documentation-Compendium.svg)](https://github.com/kylelobo/The-Documentation-Compendium/issues)
 12 |   [![GitHub Pull Requests](https://img.shields.io/github/issues-pr/kylelobo/The-Documentation-Compendium.svg)](https://github.com/kylelobo/The-Documentation-Compendium/pulls)
 13 |   [![License](https://img.shields.io/badge/license-MIT-blue.svg)](/LICENSE)
 14 | 
 15 | </div>
 16 | 
 17 | ---
 18 | 
 19 | <p align="center"> 简短几行来描述你的项目
 20 |     <br> 
 21 | </p>
 22 | 
 23 | ## 📝 目录
 24 | - [关于](#about)
 25 | - [快速开始](#getting_started)
 26 | - [部署](#deployment)
 27 | - [使用方法](#usage)
 28 | - [构建使用库](#built_using)
 29 | - [待完成](../TODO.md)
 30 | - [贡献](../CONTRIBUTING.md)
 31 | - [作者](#authors)
 32 | - [致谢](#acknowledgement)
 33 | 
 34 | ## 🧐 关于 <a name = "about"></a>
 35 | 关于你项目的目的，写1-2个段落。
 36 | 
 37 | ## 🏁 快速开始 <a name = "getting_started"></a>
 38 | 这些指令会让你复制整个项目，并在本地机器上运行以进行开发和测试。
 39 | 查看[部署](#deployment)，获取如何在线上系统部署的信息。
 40 | 
 41 | ### 准备工作
 42 | 
 43 | 需要哪些软件以及如何安装它们。
 44 | 
 45 | ```
 46 | 例子
 47 | ```
 48 | 
 49 | ### 安装
 50 | 一步步的介绍如何运行开发环境。
 51 | 
 52 | 介绍每个步骤
 53 | 
 54 | ```
 55 | 给出例子
 56 | ```
 57 | 
 58 | 然后重复
 59 | 
 60 | ```
 61 | 直到完成
 62 | ```
 63 | 
 64 | 在例子最后，从搭好的系统中获取一些数据，或者介绍如何使用它做个小的demo展示。
 65 | 
 66 | ## 🔧 运行测试 <a name = "tests"></a>
 67 | 解释如何对系统运行自动化测试。
 68 | 
 69 | ### 分解到端对端测试
 70 | 解释测试的内容以及为什么
 71 | 
 72 | ```
 73 | 给出例子
 74 | ```
 75 | 
 76 | ### 还有代码风格测试
 77 | 解释测试的内容以及为什么
 78 | 
 79 | ```
 80 | 给出例子
 81 | ```
 82 | 
 83 | ## 🎈 使用方法 <a name="usage"></a>
 84 | 介绍如何使用这个系统。
 85 | 
 86 | ## 🚀 部署 <a name = "deployment"></a>
 87 | 增加一些关于如何部署到线上系统的信息。
 88 | 
 89 | ## ⛏️ 构建使用库 <a name = "built_using"></a>
 90 | - [MongoDB](https://www.mongodb.com/) - 数据库
 91 | - [Express](https://expressjs.com/) - 服务器框架
 92 | - [VueJs](https://vuejs.org/) - Web框架
 93 | - [NodeJs](https://nodejs.org/en/) - 服务器环境
 94 | 
 95 | ## ✍️ 作者 <a name = "authors"></a>
 96 | - [@kylelobo](https://github.com/kylelobo) - 想法和最初工作
 97 | 
 98 | 同样感谢这些[贡献者](https://github.com/kylelobo/The-Documentation-Compendium/contributors)参与到本项目的工作中。
 99 | ## 🎉 致谢 <a name = "acknowledgement"></a>
100 | - 感谢所有为这个项目
101 | - 提供灵感的代码编写者
102 | - 提供参考的代码编写者
103 | 


--------------------------------------------------------------------------------
/cn/TODO.md:
--------------------------------------------------------------------------------
1 | ### TODO
2 | 
3 | ---
4 | 
5 | - [ ] переводить шаблоны
6 | 
7 | 


--------------------------------------------------------------------------------
/de/CHANGELOG.md:
--------------------------------------------------------------------------------
 1 | # Changelog
 2 | Alle bemerkenswerten Änderungen an diesem Projekt werden in dieser Datei 
 3 | dokumentiert.
 4 |  
 5 | Das Format basiert auf [Führe ein Changelog](https://keepachangelog.com/de/)
 6 | und dieses Projekt folgt [Semantic Versioning](https://semver.org/lang/de/).
 7 |  
 8 | ## [Releasenummer] - jjjj-mm-tt
 9 |  
10 | Hier wird die Zusammenfassung der Version festgehalten. Das Team ist angehalten, 
11 | die Beschreibung so kompakt wie möglich zu machen.
12 |  
13 | ### Hinzugefügt
14 | - [PROJEKTNAME-XXXX](http://tickets.projectname.com/browse/PROJEKTNAME-XXXX)
15 |   MINOR Hier wird die Überschrift des ARBEITSPAKETS festgehalten.
16 | - [PROJEKTNAME-YYYY](http://tickets.projectname.com/browse/PROJEKTNAME-YYYY)
17 |   PATCH Hier wird die Überschrift des ARBEITSPAKETS festgehalten.
18 |  
19 | ### Geändert
20 |  
21 | ### Korrigiert
22 |  
23 | ## [1.2.4] - 2017-03-15
24 |   
25 | Hier werden die Veränderungen für 1.2.4 festgehaltenen, die für die Benutzer
26 | relevant sind.
27 |  
28 | ### Added
29 |  
30 | ### Changed
31 |   
32 | - [PROJEKTNAME-ZZZZ](http://tickets.projectname.com/browse/PROJEKTNAME-ZZZZ)
33 |   PATCH Drupal.org wird jetzt als Composer verwendet.
34 |  
35 | ### Fixed
36 |  
37 | - [PROJEKTNAME-TTTT](http://tickets.projectname.com/browse/PROJEKTNAME-TTTT)
38 |   PATCH Logik zu "Runsheet Teaser Delete" hinzugefügt um die verbundenen
39 |   Terminkarten ebenfalls zu löschen.
40 |  
41 | ## [1.2.3] - 2017-03-14
42 |  
43 | ### Added
44 |    
45 | ### Changed
46 |  
47 | ### Fixed
48 |  
49 | - [PROJEKTNAME-UUUU](http://tickets.projectname.com/browse/PROJEKTNAME-UUUU)
50 |   MINOR Korrekturen aus den Tests von Modul Foo
51 | - [PROJEKTNAME-RRRR](http://tickets.projectname.com/browse/PROJEKTNAME-RRRR)
52 |   MAJOR Die Timeline aus Modul Foo verwendete die Zeitzone des Browsers für 
53 |   die Ermittlung des Datums
54 | 


--------------------------------------------------------------------------------
/de/CODEBASE_STRUCTURE.md:
--------------------------------------------------------------------------------
 1 | Dies sind die Verzeichnisse, die wir aktiv in der Entwicklung einsetzen:
 2 | 
 3 | + [frontend/server/controllers](https://github.com/kylelobo/The-Documentation-Compendium/tree/master/frontend/server/controllers): 
 4 | Die Controller führen die Businesslogik aus und machen die Server-API verfügbar.
 5 | + [frontend/server/libs](https://github.com/The-Documentation-Compendium/tree/master/frontend/server/libs): Bibliotheken und Dienstprogramme.
 6 | + [frontend/server/libs/dao](https://github.com/The-Documentation-Compendium/tree/master/frontend/server/libs/dao): Data 
 7 | Access Objects [DAO] und Value Objects [VO]. Klassen, die zur Darstellung von 
 8 | Datenbankschemata und zur erleichterten Verwendung durch die Controller 
 9 | verwendet werden.
10 | + [frontend/templates](https://github.com/The-Documentation-Compendium/tree/master/frontend/templates): Smarty-Vorlagen zum Generieren des HTML-Codes, der den Benutzern angezeigt 
11 | wird.
12 | + [frontend/www](https://github.com/The-Documentation-Compendium/tree/master/frontend/www): 
13 | Der vollständige Inhalt der Internetseite.
14 | 
15 | ### frontend / www
16 | Inhalt:
17 | 
18 | + js /
19 | + css /
20 | 
21 | #### js
22 | Wie der Name schon sagt, befinden sich hier alle Javascript-Schriftarten und 
23 | Javascript-Frameworks. Codeänderungen, die hier vorgenommen werden, müssen vor 
24 | dem Upload mittels Minify komprimiert werden.
25 | 
26 | #### css
27 | Ähnlich wie bei js sind hier die durch Minify verkleinerten CSS-Dateien.
28 | 
29 | ### frontend / server
30 | Inhalt:
31 | 
32 | * dao /
33 | * controllers /
34 | 
35 | Keines dieser Module sollte für die Außenwelt zugänglich sein. Sie können 
36 | lediglich durch die Benutzeroberfläche aufgerufen werden. Aus diesem Grund 
37 | befinden sie sich im Ordner www.
38 | 
39 | #### DAO / VO
40 | 
41 | Der Ordner *dao* enthält die Klassen für die Datenzugriffsschicht. Hier gibt es 
42 | zwei relevante Dinge: *data access objects* und *value objects*. 
43 | *Value objects* (VO) sind nichts anderes als Klassen, die direkt jeder der 
44 | Tabellen in der Datenbank zugeordnet sind. Daher gibt es dort beispielse eine 
45 | Klasse namens Users, da es eine Tabelle mit dem selben Namen gibt. Diese Klasse 
46 | hat ihre Setter und Getter für jedes der Felder in der Datenbank. Die 
47 | *data access objects* (dao) sind statische Klassen für jede der Tabellen und 
48 | dienen dazu, die Objekte zu erhalten und zu dauerhaften *VO*'s zu machen.
49 | 
50 | [Hier finden Sie weitere Informationen zu diesem Modell](http://www.ibm.com/developerworks/java/library/j-dao/)
51 | 
52 | #### Controller
53 | 
54 | In den Controllern werden die Entscheidungen getroffen. Der Controller verwendet 
55 | die DAOs und VOs, um Entscheidungen zu treffen, und ruft die Datenbank niemals 
56 | direkt auf. Auf diese Weise vermeiden wir separate Controller für jedes Modul 
57 | des Projekts.
58 | 
59 | 


--------------------------------------------------------------------------------
/de/CODE_OF_CONDUCT.md:
--------------------------------------------------------------------------------
 1 | # Verhaltenskodex für Mitwirkende
 2 | 
 3 | ## Unser Versprechen
 4 | 
 5 | Im Interesse einer offenen und einladenden Umgebung versprechen wir als 
 6 | Betreuer und Mitwirkende, die Mitwirkung in unserem Projekt und unserer 
 7 | Community zu einer gemeinschaftlichen und gewaltlosen Erfahrung für Jederman, 
 8 | unabhängig von Alter, Körpergröße, Behinderung, ethnischer Zugehörigkeit, 
 9 | Geschlechtsmerkmalen und Geschlechtsidentität und Ausdruck, Erfahrungsniveau, 
10 | Bildung, sozioökonomischer Status, Nationalität, persönliches Aussehen, 
11 | Rasse, Religion oder sexuelle Identität und Orientierung zu machen.
12 | 
13 | ## Unsere Standards
14 | 
15 | Beispiele für Verhaltensweisen, die zur Schaffung eines positiven Umfelds 
16 | beitragen, sind:
17 | 
18 | * Eine einladende und integrative Sprache benutzen
19 | * Respekt gegenüber unterschiedlichen Standpunkten und Erfahrungen haben
20 | * Konstruktive Kritik würdevoll annehmen
21 | * Konzentration auf das, was das Beste für die Community ist
22 | * Empathie gegenüber anderen Community-Mitgliedern zeigen
23 | 
24 | Beispiele für inakzeptables Verhalten der Teilnehmer sind:
25 | 
26 | * Die Verwendung von sexualisierter Sprache oder Bildsprache und 
27 | unerwünschte sexuelle Aufmerksamkeit oder Aufwartungen
28 | * Trolling, beleidigende/abfällige Kommentare und persönliche oder 
29 | politische Angriffe
30 | * Öffentliche oder private Belästigung
31 | * Veröffentlichung der privaten Informationen anderer, wie z. B. einer 
32 | physischen oder elektronischen Adresse, ohne ausdrückliche Genehmigung
33 | * Jedes Verhalten, das in einem professionellen Umfeld vernünftigerweise 
34 | als unangemessen angesehen werden könnte
35 | 
36 | ## Unsere Verantwortung
37 | 
38 | Die Projektbetreuer sind dafür verantwortlich, die Standards für akzeptables 
39 | Verhalten zu klären, und es wird erwartet, dass sie angemessene und faire 
40 | Korrekturmaßnahmen ergreifen, um auf Fälle von inakzeptablem Verhalten zu 
41 | reagieren.
42 | 
43 | Projektbetreuer haben das Recht und die Verantwortung, Kommentare, Commits, 
44 | Code, Wiki-Änderungen, Probleme und andere Beiträge, die nicht mit diesem 
45 | Verhaltenskodex in Einklang stehen, zu entfernen, zu bearbeiten oder 
46 | abzulehnen oder Mitwirkende für Verhaltensweisen vorübergehend oder 
47 | dauerhaft zu sperren, die sie für unangemessen, bedrohlich, beleidigend 
48 | oder schädlich halten.
49 | 
50 | ## Umfang
51 | 
52 | Dieser Verhaltenskodex gilt sowohl innerhalb von Projekträumen als auch im 
53 | öffentlichen Raum, wenn eine Person das Projekt oder seine Gemeinschaft 
54 | vertritt. Beispiele für die Vertretung eines Projekts oder einer Community sind 
55 | die Verwendung einer offiziellen Projekt-E-Mail-Adresse, die Veröffentlichung 
56 | über ein offizielles Social-Media-Konto oder die Vertretung bei einer Online- 
57 | oder Offline-Veranstaltung. Die Darstellung eines Projekts kann von den 
58 | Projektbetreuern weiter definiert und erklärt werden.
59 | 
60 | ## Durchführung
61 | 
62 | Fälle von missbräuchlichem, belästigendem oder anderweitig inakzeptablem 
63 | Verhalten können gemeldet werden, indem Sie sich an das Projektteam unter 
64 | kylelobo20@gmail.com wenden. Alle Beschwerden werden geprüft und untersucht und 
65 | führen zu einer Antwort, die als notwendig und den Umständen entsprechend 
66 | erachtet wird. Das Projektteam ist verpflichtet, die Vertraulichkeit gegenüber 
67 | dem Berichterstatter eines Vorfalls zu wahren. Weitere Einzelheiten zu 
68 | bestimmten Durchsetzungsrichtlinien können separat veröffentlicht werden.
69 | 
70 | Projektbetreuer, die den Verhaltenskodex nicht nach bestem Wissen und Gewissen 
71 | befolgen oder durchsetzen, können mit vorübergehenden oder dauerhafte 
72 | Konsequenzen konfrontiert werden, die von anderen Mitgliedern der Projektleitung 
73 | festgelegt werden.
74 | 
75 | ## Quellverweis
76 | 
77 | Dieser Verhaltenskodex wurde aus dem [Contributor Covenant][Homepage], 
78 | Version 1.4, verfügbar unter 
79 | https://www.contributor-covenant.org/version/1/4/code-of-conduct.html, 
80 | übernommen.
81 | 
82 | [Homepage]: https://www.contributor-covenant.org
83 | 
84 | Antworten auf häufig gestellte Fragen zu diesem Verhaltenskodex finden Sie unter
85 | https://www.contributor-covenant.org/faq
86 | 


--------------------------------------------------------------------------------
/de/CODING_GUIDELINES.md:
--------------------------------------------------------------------------------
 1 | # Sourcecoderichtlinien
 2 | 
 3 | - Sie können überprüfen, ob Ihr Code diesen Richtlinien entspricht, indem Sie 
 4 | `stuff/php-format.py validate` ausführen
 5 | - Tabulatoren, keine Leerzeichen
 6 | - Das Zeilenende sollte im Unix-Stil (`\n`) und nicht im Windows-Stil (`\r\n`) 
 7 | sein.
 8 | - Das Öffnen von Klammern erfolgt in derselben Zeile wie die letzte Anweisung
 9 | ```
10 |     if (condition) {
11 |         stuff;
12 |     }
13 | ```
14 | - Ein Leerzeichen zwischen Schlüsselwörtern und Klammern für: `if`, `else`, 
15 | `while`, `switch`, `catch`, `function`
16 | - Funktionsaufrufe haben vor den Klammern kein Leerzeichen
17 | - In den Klammern bleiben keine Leerzeichen
18 | - Ein Leerzeichen nach jedem Komma, jedoch ohne Leerzeichen davor
19 | - Alle binären Operatoren müssen ein Leerzeichen davor und danach haben
20 | - Es sollte nicht mehr als eine aneinanderfolgende Leerzeile geben
21 | - Es sollten keine leeren Kommentare vorhanden sein
22 | - Sie sollten keine Blockkommentare `/* ... */` verwenden, sondern nur 
23 | Zeilenkommentare `// ...`
24 | - Änderungen der Funktionalität müssen gemeinsam mit ihren jeweiligen neuen / 
25 | geänderten Tests hochgeladen werden
26 | - Exceptions müssen verwendet werden, um fehlerhafte Zustände zu melden. Die 
27 | Verwendung von Funktionen, die true / false zurückgeben, ist zulässig, wenn es 
28 | sich um erwartete Werte handelt
29 | - Verwenden Sie gegebenenfalls [RAII](http://en.wikipedia.org/wiki/Resource_Acquisition_Is_Initialization), insbesondere bei der Verwaltung von 
30 | Ressourcen (Dateien usw.)


--------------------------------------------------------------------------------
/de/CONTRIBUTING.md:
--------------------------------------------------------------------------------
 1 | # Richtlinien für Beiträge
 2 | 
 3 | - An "The Documentation Compendium" mit zu wirken ist ziemlich einfach. Dieses 
 4 | Dokument zeigt die ersten Schritte
 5 | 
 6 | ## Allgemeines
 7 | - Die [Codebase Structure](./CODEBASE_STRUCTURE.md) enthält detaillierte 
 8 | Informationen zur Struktur der verschiedenen Dateien in diesem Projekt
 9 | - Es muss sicher gestellt sein, dass alle vorgenommenen Änderungen den 
10 | [Coding Guidelines](./CODING_GUIDELINES.md) dieses Repos entsprechen
11 | 
12 | ## Änderungen einreichen
13 | 
14 | - Einen Fork des Repos erzeugen
15 |   - <https://github.com/kylelobo/The-Documentation-Compendium/fork>
16 | - Einen neuen Branch auschecken und einen Namen vergeben, der beschreibt, was 
17 | geändert wird (z.B. <code>fooBar</code>): 
18 |   - Beispiel:
19 |     ````
20 |     $ git checkout -b fooBar
21 |     ````
22 |     Falls ein Fehler ausgegeben wird, muss möglicherweise der aktuelle Stand 
23 |     durch folgende Befehle geholt werden:
24 |     ````
25 |     $ git remote update && git fetch
26 |     ````
27 |   - Immer nur einen Branch pro Fix / Feature verwenden
28 | - Änderungen übernehmen
29 |   - Bitte eine Git-Nachricht verfassen, die beschreibt, was geändert wurde
30 |   - Bitte sicherstellen, dass die Commits den [Konventionen](https://gist.github.com/robertpainsi/b632364184e70900af4ab688decf6f53#file-commit-message-guidelines-md) 
31 |   entsprechen
32 |   - Immer in das geforkte Repository commiten
33 |   - Beispiel:
34 |     ````
35 |     $ git commit -am 'Add some fooBar'
36 |     ````
37 | - In den Branch pushen
38 |   - Example:
39 |     ````
40 |     $ git push origin BRANCH_NAME
41 |     ````
42 | - Einen Pull-Request eröffnen
43 |   - Sicherstellen, dass der PR an den Zweig <code>fooBar</code> gesendet wird
44 |   - Travis CI is watching you!
45 | 
46 | Wenn diese Anweisungen befolgt werden, landet der PR ziemlich sicher im 
47 | Haupt-Repo!


--------------------------------------------------------------------------------
/de/ISSUE_TEMPLATES/bug_report.md:
--------------------------------------------------------------------------------
 1 | ---
 2 | name: Fehlerbericht
 3 | about: Einen Bericht erstellen um uns die Möglichkeit zur Verbesesrung zu geben
 4 | title: ''
 5 | labels: ''
 6 | assignees: ''
 7 | ---
 8 | 
 9 | **Fehlerbeschreibung:**
10 | 
11 | Eine klare und präzise Beschreibung des Fehlers.
12 | 
13 | **Reproduktion:**
14 | 
15 | Schritte zum Reproduzieren des Verhaltens:
16 | 1. Gehe nach '...'
17 | 2. Clicke auf '....'
18 | 3. Scrolle bis '....'
19 | 4. Erhalte den Fehler
20 | 
21 | **Erwartetes Verhalten:**
22 | Eine klare und präzise Beschreibung dessen, was erwartet wird.
23 | 
24 | **Screenshots:**
25 | Gegebenenfalls Schreenshots hinzufügen um das Problem zu erklären.
26 | 
27 | **Desktop (bitte die folgenden Informationen bekanntgeben):**
28 |  - OS: [z.B. iOS]
29 |  - Browser [z.B. chrome, safari]
30 |  - Version [z.B. 22]
31 | 
32 | **Smartphone (bitte die folgenden Informationen bekanntgeben):**
33 |  - Device: [z.B. iPhone6]
34 |  - OS: [z.B. iOS8.1]
35 |  - Browser [z.B. stock browser, safari]
36 |  - Version [z.B. 22]
37 | 
38 | **Zusätzlicher Kontext:**
39 | Alle weitere Angaben in Verbindung mit dem Problem.
40 | 


--------------------------------------------------------------------------------
/de/ISSUE_TEMPLATES/custom.md:
--------------------------------------------------------------------------------
 1 | ---
 2 | name: Benutzerdefinierte Vorlage
 3 | about: Den Zweck der Vorlage hier beschreiben.
 4 | title: ''
 5 | labels: ''
 6 | assignees: ''
 7 | 
 8 | ---
 9 | 
10 | 
11 | 


--------------------------------------------------------------------------------
/de/ISSUE_TEMPLATES/feature_request.md:
--------------------------------------------------------------------------------
 1 | ---
 2 | name: Funktionsanfrage
 3 | about: Vorschlag einer Idee für dieses Projekt
 4 | title: ''
 5 | labels: ''
 6 | assignees: ''
 7 | 
 8 | ---
 9 | 
10 | **Bezieht sich Ihre Funktionsanfrage auf ein Problem? Bitte beschreiben.**
11 | Eine klare und präzise Beschreibung des Problems. Z.B.: Ich bin immer 
12 | frustriert, wenn [...]
13 | 
14 | **Beschreibung der gewünschten Lösung**
15 | Eine klare und präzise Beschreibung dessen, was passieren soll.
16 | 
17 | **Beschreibung der Alternativen, die Sie in Betracht gezogen wurden**
18 | Eine klare und präzise Beschreibung aller alternativen Lösungen oder Funktionen, 
19 | die in Betracht gezogen wurden.
20 | 
21 | **Zusätzlicher Kontext**
22 | Weiterer Kontexte oder Screenshots zur Funktionsanforderung.
23 | 


--------------------------------------------------------------------------------
/de/PULL_REQUEST_TEMPLATE.md:
--------------------------------------------------------------------------------
 1 | ### Checkliste für Pull-Requests
 2 | 🚨 Bitte lesen Sie die [Richtlinien für Beiträge](./CONTRIBUTING.md) zu diesem Repository.
 3 | 
 4 | - [ ] Sicherstellen, dass ein **Themen-/Feature-/Bugfix-Zweig** requestet wird
 5 | (rechte Seite). Nicht den master Branch requesten!
 6 | - [ ] Sicherstellen, dass eine Pull-Anfragen für den **fooBar-Zweig** (linke 
 7 | Seite) gestellt wird.
 8 | - [ ] Überprüfen, ob die Commits Struktur der vorgegebenen Struktur entspricht.
 9 | - [ ] Sicherstellen, dass die Codeerweiterungen sowohl Code Linting- als auch 
10 | Unit-Tests erfolgreich bestehen.
11 | 
12 | ### Beschreibung
13 | Bitte den Pull-Request beschreiben.
14 | 
15 | ❤️ Vielen Dank!
16 | 


--------------------------------------------------------------------------------
/de/README_TEMPLATES/Bot.md:
--------------------------------------------------------------------------------
  1 | <p align="center">
  2 |   <a href="" rel="noopener">
  3 |  <img width=200px height=200px src="https://i.imgur.com/FxL5qM0.jpg" alt="Bot logo"></a>
  4 | </p>
  5 | 
  6 | <h2 align="center">Name des Bots</h2>
  7 | 
  8 | <div align="center">
  9 | 
 10 |   [![Status](https://img.shields.io/badge/status-active-success.svg)]()
 11 |   [![Platform](https://img.shields.io/badge/platform-reddit-orange.svg)](https://www.reddit.com/user/Wordbook_Bot)
 12 |   [![GitHub Issues](https://img.shields.io/github/issues/kylelobo/The-Documentation-Compendium.svg)](https://github.com/kylelobo/The-Documentation-Compendium/issues)
 13 |   [![GitHub Pull Requests](https://img.shields.io/github/issues-pr/kylelobo/The-Documentation-Compendium.svg)](https://github.com/kylelobo/The-Documentation-Compendium/pulls)
 14 |   [![License](https://img.shields.io/badge/license-MIT-blue.svg)](/LICENSE)
 15 | 
 16 | </div>
 17 | 
 18 | ---
 19 | 
 20 | <p align="center">
 21 |     🤖 Ein paar Zeilen, die beschreiben, was der Bot macht.
 22 |     <br> 
 23 | </p>
 24 | 
 25 | ## 📝 Inhaltsverzeichnis
 26 | + [Über](#ueber)
 27 | + [Demo / Arbeitsweise](#demo)
 28 | + [Funktionsbeschreibung](#funktionsbeschreibung)
 29 | + [Verwendung](#verwendung)
 30 | + [Einstieg](#einstieg)
 31 | + [Bereitstellen eines eigenen Bots](#bereitstellung)
 32 | + [Erstellt mit](#erstellt_mit)
 33 | + [TODO](../TODO.md)
 34 | + [Mitwirkung](../CONTRIBUTING.md)
 35 | + [Autoren](#autoren)
 36 | + [Danksagung](#danksagung)
 37 | 
 38 | ## 🧐 Über <a name = "ueber"></a>
 39 | Ungefähr 1-2 Absätze, die den Zweck des Bots beschreiben.
 40 | 
 41 | ## 🎥 Demo / Arbeitsweise <a name = "demo"></a>
 42 | ![Arbeitsweise](https://media.giphy.com/media/20NLMBm0BkUOwNljwv/giphy.gif)
 43 | 
 44 | ## 💭 Funktionsbeschreibung <a name = "funktionsbeschreibung"></a>
 45 | Der Bot extrahiert zuerst das Wort aus dem Kommentar und ruft dann 
 46 | Wortdefinitionen, ein Beispiel und Abstammung aus der Oxford Dictionary-API ab.
 47 | 
 48 | Wenn das Wort im Oxford Dictionary nicht vorhanden ist, gibt die Oxford API eine 
 49 | 404-Antwort zurück, worauf der Bot dann versucht, Ergebnisse aus der Urban 
 50 | Dictionary API abzurufen.
 51 | 
 52 | Der Bot verwendet die Pushshift-API zum Abrufen von Kommentaren, das PRAW-Modul 
 53 | zum Antworten auf Kommentare und Heroku als Server.
 54 | 
 55 | Der gesamte Bot ist in Python 3.6 geschrieben.
 56 | 
 57 | ## 🎈 Verwendung <a name = "verwendung"></a>
 58 | 
 59 | Um den Bot zu verwenden folgenden Befehl tippen:
 60 | ```
 61 | !dict word
 62 | ```
 63 | Der erste Teil, als "!dict" **ist nicht** Case sensitiv.
 64 | 
 65 | Der Bot gibt Ihnen dann die Definition des Wortes im Oxford Dictionary (oder 
 66 | Urban Dictionary; falls das Wort im Oxford Dictionary nicht vorhanden ist) 
 67 | als Kommentarantwort.
 68 | 
 69 | ### Beispiel:
 70 | 
 71 | > !dict what is love
 72 | 
 73 | **Definition:**
 74 | 
 75 | Baby, dont hurt me~
 76 | Dont hurt me~ no more.
 77 | 
 78 | **Beispiel:**
 79 | 
 80 | Dude1: Bruh, what is love? <br>
 81 | Dude2: Baby, dont hurt me, dont hurt me- no more! <br>
 82 | Dude1: dafuq?
 83 | 
 84 | **Quelle:** https://www.urbandictionary.com/define.php?term=what%20is%20love
 85 | 
 86 | ---
 87 | 
 88 | <sup>Beep boop. Ich bin ein Bot. Wenn es Probleme gibt, kontaktiere meinen [Meister](https://www.reddit.com/message/compose/?to=PositivePlayer1&subject=/u/Wordbook_Bot)</sup>
 89 | 
 90 | <sup>Willst du einen ähnlichen reddit Bot machen? Probiere: [GitHub](https://github.com/kylelobo/Reddit-Bot)</sup>
 91 | 
 92 | ## 🏁 Einstieg <a name = "einstieg"></a>
 93 | Mit diesen Anweisungen erhalten Sie eine Kopie des Projekts, das zu 
 94 | Entwicklungs- und Testzwecken auf Ihrem lokalen Computer ausgeführt werden kann. 
 95 | Hinweise zum Bereitstellen des Projekts auf einem Live-System finden Sie unter 
 96 | [Bereitstellen eines eigenen Bots](#bereitstellung).
 97 | 
 98 | ### Voraussetzungen
 99 | 
100 | Welche Dinge werden benötigt um die Software zu installieren und wie wird sie 
101 | installiert?
102 | 
103 | ```
104 | Hier Beispiele geben
105 | ```
106 | 
107 | ### Installation
108 | 
109 | Eine Schritt für Schritt Anleitung die zeigt, wie die Entwicklungsumgebung zum 
110 | Laufen gebracht wird.
111 | 
112 | Beschreibe den Schritt
113 | 
114 | ```
115 | Gib ein Beispiel
116 | ```
117 | 
118 | Und wiederhole
119 | 
120 | ```
121 | bis zur Fertigstellung.
122 | ```
123 | 
124 | Zum Schluss noch ein Beispiel, wie einige Daten aus dem System geholt werden 
125 | oder für eine kleine Demo verwendet werden.
126 | 
127 | ## 🚀 Bereitstellen eines eigenen Bots <a name = "bereitstellung"></a>
128 | Ein Beispielprojekt zur Bereitstellung Ihres Bots finden Sie in meiner eigenen 
129 | Konfiguration:
130 | 
131 | + **Heroku**: https://github.com/kylelobo/Reddit-Bot#deploying_the_bot
132 | 
133 | ## ⛏️ Erstellt mit <a name = "erstellt_mit"></a>
134 | + [PRAW](https://praw.readthedocs.io/en/latest/) - Python Reddit API Wrapper
135 | + [Heroku](https://www.heroku.com/) - SaaS hosting platform
136 | 
137 | ## ✍️ Autoren <a name = "autoren"></a>
138 | + [@kylelobo](https://github.com/kylelobo) - Idee & Erste Version
139 | 
140 | Siehe auch die Liste der [Mitwirkenden](https://github.com/kylelobo/The-Documentation-Compendium/contributors), die an diesem Projekt teilgenommen haben.
141 | 
142 | ## 🎉 Danksagung <a name = "danksagung"></a>
143 | + Hut ab vor Jedem, dessen Code verwendet wurde
144 | + Inspiration
145 | + Verweise
146 | 


--------------------------------------------------------------------------------
/de/README_TEMPLATES/Hackathon.md:
--------------------------------------------------------------------------------
  1 | <p align="center">
  2 |   <a href="" rel="noopener">
  3 |  <img src="https://i.imgur.com/AZ2iWek.png" alt="Project logo"></a>
  4 | </p>
  5 | <h2 align="center">Projekttitel</h2>
  6 | 
  7 | <div align="center">
  8 | 
  9 |   [![Hackathon](https://img.shields.io/badge/hackathon-projekttitel-orange.svg)](http://hackathon.url.com) 
 10 |   [![Status](https://img.shields.io/badge/status-active-success.svg)]() 
 11 |   [![GitHub Issues](https://img.shields.io/github/issues/kylelobo/The-Documentation-Compendium.svg)](https://github.com/kylelobo/The-Documentation-Compendium/issues)
 12 |   [![GitHub Pull Requests](https://img.shields.io/github/issues-pr/kylelobo/The-Documentation-Compendium.svg)](https://github.com/kylelobo/The-Documentation-Compendium/pulls)
 13 |   [![License](https://img.shields.io/badge/license-MIT-blue.svg)](LICENSE.md)
 14 | 
 15 | </div>
 16 | 
 17 | ---
 18 | 
 19 | <p align="center"> 
 20 |     Ein paar Zeilen, die das Projekt beschreiben.
 21 |     <br> 
 22 | </p>
 23 | 
 24 | ## 📝 Inhaltsverzeichnis
 25 | - [Problemstellung](#problemstellung)
 26 | - [Idee / Lösung](#idee)
 27 | - [Abhängigkeiten / Einschränkungen](#einschraenkungen)
 28 | - [Zukünftiger Geltungsbereich](#geltungsbereich)
 29 | - [Einstieg](#einstieg)
 30 | - [Verwendung](#verwendung)
 31 | - [Technologie-Stack](#tech_stack)
 32 | - [Mitwirkung](../CONTRIBUTING.md)
 33 | - [Autoren](#autoren)
 34 | - [Danksagung](#danksagung)
 35 | 
 36 | ## 🧐 Problemstellung <a name = "problemstellung"></a>
 37 | 
 38 | Es ist nützlich, beim Schreiben einer Problemstellung ein bestimmtes Format zu 
 39 | entwerfen und diesem zu folgen. Es gibt verschiedene Möglichkeiten, dies zu tun. 
 40 | Das Folgende ist eine einfache und unkomplizierte Vorlage, die häufig in der 
 41 | Geschäftsanalyse eingesetzt wird, um den Fokus auf der  Definition des Problems 
 42 | zu halten.
 43 | 
 44 | - IDEAL: In diesem Abschnitt wird der gewünschte oder Soll-Zustand des Prozesses 
 45 | oder Produkts beschrieben. Im Großen und Ganzen sollte dieser Abschnitt 
 46 | veranschaulichen, wie die erwartete Umgebung nach der Implementierung der Lösung 
 47 | aussehen würde.
 48 | - REALITÄT: In diesem Abschnitt wird der aktuelle oder Ist-Zustand des Prozesses 
 49 | oder Produkts beschrieben.
 50 | - FOLGEN: In diesem Abschnitt werden die Auswirkungen auf das Unternehmen 
 51 | beschrieben, wenn das Problem nicht behoben oder verbessert wird. Dies schließt 
 52 | Kosten ein, die mit Kapitalverlust, Zeit, Produktivität, Wettbewerbsvorteil usw. 
 53 | verbunden sind.
 54 | 
 55 | Mit Hilfe dieses Formats wird ein Dokument erstellt, das genutzt werden kann um 
 56 | das Problem zu vermitteln und Anforderungen zu definieren, die zu einer 
 57 | erfolgreichen Lösung führen.
 58 | ## 💡 Idee / Lösung <a name = "idee"></a>
 59 | 
 60 | In diesem Abschnitt werden mögliche Lösungen beschrieben.
 61 | 
 62 | Sobald die Abschnitte Ideal, Realität und Konsequenzen abgeschlossen und 
 63 | verinnerlicht wurden wird es einfacher, eine Lösung zur Klärung des Problems 
 64 | zu definieren.
 65 | 
 66 | ## ⛓️ Abhängigkeiten / Einschränkungen <a name = "einschraenkungen"></a>
 67 | - Was sind die Abhängigkeiten des Projekts?
 68 | - Beschreibe jede Einschränkung kurz und bündig
 69 | - Erkläre warum die Einschränkung besteht
 70 | - Begründe, warum die Einschränkung mit den ausgewählten Methoden nicht 
 71 | beseitigt werden konnte.
 72 | - Bewerte die Auswirkungen jeder Einschränkung in Bezug auf das Gesamtergebnis 
 73 | des Projekts und beschreibe gegebenenfalls, wieso diese Einschränkungen auf die 
 74 | Notwendigkeit weiterer Nachforschungen hinweisen.
 75 | 
 76 | ## 🚀 Zukünftiger Geltungsbereich <a name = "geltungsbereich"></a>
 77 | Schreiben darüber, was im Verlauf des Hackathons nicht entwickelt werden konnte 
 78 | und darüber, was Ihr Projekt in Zukunft erreichen kann.
 79 | 
 80 | ## 🏁 Einstieg <a name = "einstieg"></a>
 81 | Mit diesen Anweisungen erhalten Sie eine Kopie des Projekts, das zu 
 82 | Entwicklungs- und Testzwecken auf Ihrem lokalen Computer ausgeführt werden kann. 
 83 | 
 84 | ### Voraussetzungen
 85 | 
 86 | Welche Dinge werden benötigt um die Software zu installieren und wie wird sie 
 87 | installiert?
 88 | 
 89 | ```
 90 | Hier Beispiele geben
 91 | ```
 92 | 
 93 | ### Installation
 94 | 
 95 | Eine Schritt für Schritt Anleitung die zeigt, wie die Entwicklungsumgebung zum 
 96 | Laufen gebracht wird.
 97 | 
 98 | Beschreibe den Schritt
 99 | 
100 | ```
101 | Gib ein Beispiel
102 | ```
103 | 
104 | Und wiederhole
105 | 
106 | ```
107 | bis zur Fertigstellung.
108 | ```
109 | 
110 | ## 🎈 Verwendung <a name="verwendung"></a>
111 | Füge Hinweise zur Verwendung des Systems hinzu.
112 | 
113 | ## ⛏️ Technologie-Stack <a name = "tech_stack"></a>
114 | - [MongoDB](https://www.mongodb.com/) - Database
115 | - [Express](https://expressjs.com/) - Server Framework
116 | - [VueJs](https://vuejs.org/) - Web Framework
117 | - [NodeJs](https://nodejs.org/en/) - Server Environment
118 | 
119 | ## ✍️ Autoren <a name = "autoren"></a>
120 | + [@kylelobo](https://github.com/kylelobo) - Idee & Erste Version
121 | 
122 | Siehe auch die Liste der [Mitwirkenden](https://github.com/kylelobo/The-Documentation-Compendium/contributors), die an diesem Projekt teilgenommen haben.
123 | 
124 | ## 🎉 Danksagung <a name = "danksagung"></a>
125 | + Hut ab vor Jedem, dessen Code verwendet wurde
126 | + Inspiration
127 | + Verweise
128 | 


--------------------------------------------------------------------------------
/de/README_TEMPLATES/IoT.md:
--------------------------------------------------------------------------------
1 | TODO
2 | 


--------------------------------------------------------------------------------
/de/README_TEMPLATES/Minimal.md:
--------------------------------------------------------------------------------
 1 | # Projekttitel
 2 | 
 3 | ## Inhaltsverzeichnis
 4 | + [Über](#ueber)
 5 | + [Einstieg](#einstieg)
 6 | + [Verwendung](#verwendung)
 7 | + [Mitwirkung](../CONTRIBUTING.md)
 8 | 
 9 | ## Über <a name = "ueber"></a>
10 | Ungefähr 1-2 Absätze, die den Zweck des Projekts beschreiben.
11 | 
12 | ## Einstieg <a name = "einstieg"></a>
13 | Mit diesen Anweisungen erhalten Sie eine Kopie des Projekts, das zu 
14 | Entwicklungs- und Testzwecken auf Ihrem lokalen Computer ausgeführt werden kann. 
15 | 
16 | ### Voraussetzungen
17 | 
18 | Welche Dinge werden benötigt um die Software zu installieren und wie wird sie 
19 | installiert?
20 | 
21 | ```
22 | Hier Beispiele geben
23 | ```
24 | 
25 | ### Installation
26 | 
27 | Eine Schritt für Schritt Anleitung die zeigt, wie die Entwicklungsumgebung zum 
28 | Laufen gebracht wird.
29 | 
30 | Beschreibe den Schritt
31 | 
32 | ```
33 | Gib ein Beispiel
34 | ```
35 | 
36 | Und wiederhole
37 | 
38 | ```
39 | bis zur Fertigstellung.
40 | ```
41 | 
42 | Zum Schluss noch ein Beispiel, wie einige Daten aus dem System geholt werden 
43 | oder für eine kleine Demo verwendet werden.
44 | 
45 | ## Verwendung <a name = "verwendung"></a>
46 | 
47 | Füge Hinweise zur Verwendung des Systems hinzu.
48 | 


--------------------------------------------------------------------------------
/de/README_TEMPLATES/README.md:
--------------------------------------------------------------------------------
1 | ### Dieser Ordner enthält verschiedene README-Vorlagen, die je nach Projekttyp verwendet werden können.
2 | 
3 | 1. [Bot.md](/README%20Templates/Bot.md) - 
4 | 2. [Hackathon.md](/README%20Templates/Hackathon.md) - 
5 | 3. [IoT.md](/README%20Templates/IoT.md) - 
6 | 4. [Minimal.md](/README%20Templates/Minimal.md) - 
7 | 5. [Standard.md](/README%20Templates/Standard.md) - 
8 | 


--------------------------------------------------------------------------------
/de/README_TEMPLATES/Standard.md:
--------------------------------------------------------------------------------
  1 | <p align="center">
  2 |   <a href="" rel="noopener">
  3 |  <img width=200px height=200px src="https://i.imgur.com/6wj0hh6.jpg" alt="Project logo"></a>
  4 | </p>
  5 | 
  6 | <h2 align="center">Projekttitel</h2>
  7 | 
  8 | <div align="center">
  9 | 
 10 |   [![Status](https://img.shields.io/badge/status-active-success.svg)]() 
 11 |   [![GitHub Issues](https://img.shields.io/github/issues/kylelobo/The-Documentation-Compendium.svg)](https://github.com/kylelobo/The-Documentation-Compendium/issues)
 12 |   [![GitHub Pull Requests](https://img.shields.io/github/issues-pr/kylelobo/The-Documentation-Compendium.svg)](https://github.com/kylelobo/The-Documentation-Compendium/pulls)
 13 |   [![License](https://img.shields.io/badge/license-MIT-blue.svg)](/LICENSE)
 14 | 
 15 | </div>
 16 | 
 17 | ---
 18 | 
 19 | <p align="center"> Ein paar Zeilen, die das Projekt beschreiben.
 20 |     <br> 
 21 | </p>
 22 | 
 23 | ## 📝 Table of Contents
 24 | - [Über](#ueber)
 25 | - [Einstieg](#einstieg)
 26 | - [Durchführung von Tests](#tests)
 27 | - [Bereitstellung](#bereitstellung)
 28 | - [Verwendung](#verwendung)
 29 | - [Erstellt mit](#erstellt_mit)
 30 | - [TODO](../TODO.md)
 31 | - [Mitwirkung](../CONTRIBUTING.md)
 32 | - [Autoren](#autoren)
 33 | - [Danksagung](#danksagung)
 34 | 
 35 | ## 🧐 Über <a name = "ueber"></a>
 36 | Ungefähr 1-2 Absätze, die den Zweck des Bots beschreiben.
 37 | 
 38 | ## 🏁 Einstieg <a name = "einstieg"></a>
 39 | Mit diesen Anweisungen erhalten Sie eine Kopie des Projekts, das zu 
 40 | Entwicklungs- und Testzwecken auf Ihrem lokalen Computer ausgeführt werden kann. 
 41 | Hinweise zum Bereitstellen des Projekts auf einem Live-System finden Sie unter 
 42 | [Bereitstellung](#bereitstellung).
 43 | 
 44 | ### Voraussetzungen
 45 | 
 46 | Welche Dinge werden benötigt um die Software zu installieren und wie wird sie 
 47 | installiert?
 48 | 
 49 | ```
 50 | Hier Beispiele geben
 51 | ```
 52 | 
 53 | ### Installation
 54 | 
 55 | Eine Schritt für Schritt Anleitung die zeigt, wie die Entwicklungsumgebung zum 
 56 | Laufen gebracht wird.
 57 | 
 58 | Beschreibe den Schritt
 59 | 
 60 | ```
 61 | Gib ein Beispiel
 62 | ```
 63 | 
 64 | Und wiederhole
 65 | 
 66 | ```
 67 | bis zur Fertigstellung.
 68 | ```
 69 | 
 70 | Zum Schluss noch ein Beispiel, wie einige Daten aus dem System geholt werden 
 71 | oder für eine kleine Demo verwendet werden.
 72 | 
 73 | ## 🔧 Durchführung von Tests <a name = "tests"></a>
 74 | Erkläre, wie automatische Tests für das System durchgeführt werden können.
 75 | 
 76 | ### In End-to-End Tests zerlegen
 77 | Erkläre was getestet wird und wieso.
 78 | 
 79 | ```
 80 | Gib ein Bespiel
 81 | ```
 82 | 
 83 | ### Und coding style Tests
 84 | Erkläre was getestet wird und wieso.
 85 | 
 86 | ```
 87 | Gib ein Bespiel
 88 | ```
 89 | 
 90 | ## 🚀 Bereitstellung <a name = "bereitstellung"></a>
 91 | Zusätzliche Hinweise dazu, wie das Projekt auf einem Livesystem bereitgestellt 
 92 | werden kann.
 93 | 
 94 | ## 🎈 Verwendung <a name = "verwendung"></a>
 95 | Füge Hinweise zur Verwendung des Systems hinzu.
 96 | 
 97 | ## ⛏️ Erstellt mit <a name = "erstellt_mit"></a>
 98 | - [MongoDB](https://www.mongodb.com/) - Database
 99 | - [Express](https://expressjs.com/) - Server Framework
100 | - [VueJs](https://vuejs.org/) - Web Framework
101 | - [NodeJs](https://nodejs.org/en/) - Server Environment
102 | 
103 | ## ✍️ Autoren <a name = "autoren"></a>
104 | - [@kylelobo](https://github.com/kylelobo) - Idee & Erste Version
105 | 
106 | Siehe auch die Liste der [Mitwirkenden](https://github.com/kylelobo/The-Documentation-Compendium/contributors), die an diesem Projekt teilgenommen haben.
107 | 
108 | ## 🎉 Danksagung <a name = "danksagung"></a>
109 | - Hut ab vor Jedem, dessen Code verwendet wurde
110 | - Inspiration
111 | - Verweise
112 | 


--------------------------------------------------------------------------------
/de/TODO.md:
--------------------------------------------------------------------------------
1 | ### TODO
2 | 
3 | ---
4 | 
5 | - [x] Erledigte Anpassung
6 | - [ ] Geplante Anpassungen ...
7 | - [ ] Geplante Anpassungen ...
8 | 
9 | 


--------------------------------------------------------------------------------
/en/CHANGELOG.md:
--------------------------------------------------------------------------------
 1 | # Changelog
 2 | All notable changes to this project will be documented in this file.
 3 |  
 4 | The format is based on [Keep a Changelog](http://keepachangelog.com/)
 5 | and this project adheres to [Semantic Versioning](http://semver.org/).
 6 |  
 7 | ## [Unreleased] - yyyy-mm-dd
 8 |  
 9 | Here we write upgrading notes for brands. It's a team effort to make them as
10 | straightforward as possible.
11 |  
12 | ### Added
13 | - [PROJECTNAME-XXXX](http://tickets.projectname.com/browse/PROJECTNAME-XXXX)
14 |   MINOR Ticket title goes here.
15 | - [PROJECTNAME-YYYY](http://tickets.projectname.com/browse/PROJECTNAME-YYYY)
16 |   PATCH Ticket title goes here.
17 |  
18 | ### Changed
19 |  
20 | ### Fixed
21 |  
22 | ## [1.2.4] - 2017-03-15
23 |   
24 | Here we would have the update steps for 1.2.4 for people to follow.
25 |  
26 | ### Added
27 |  
28 | ### Changed
29 |   
30 | - [PROJECTNAME-ZZZZ](http://tickets.projectname.com/browse/PROJECTNAME-ZZZZ)
31 |   PATCH Drupal.org is now used for composer.
32 |  
33 | ### Fixed
34 |  
35 | - [PROJECTNAME-TTTT](http://tickets.projectname.com/browse/PROJECTNAME-TTTT)
36 |   PATCH Add logic to runsheet teaser delete to delete corresponding
37 |   schedule cards.
38 |  
39 | ## [1.2.3] - 2017-03-14
40 |  
41 | ### Added
42 |    
43 | ### Changed
44 |  
45 | ### Fixed
46 |  
47 | - [PROJECTNAME-UUUU](http://tickets.projectname.com/browse/PROJECTNAME-UUUU)
48 |   MINOR Fix module foo tests
49 | - [PROJECTNAME-RRRR](http://tickets.projectname.com/browse/PROJECTNAME-RRRR)
50 |   MAJOR Module foo's timeline uses the browser timezone for date resolution 
51 | 


--------------------------------------------------------------------------------
/en/CODEBASE_STRUCTURE.md:
--------------------------------------------------------------------------------
 1 | These are the directories that we are actively using in the development:
 2 | 
 3 | + [frontend/server/controllers](https://github.com/kylelobo/The-Documentation-Compendium/tree/master/frontend/server/controllers): 
 4 | The controllers do the business logic and expose the server API.
 5 | + [frontend/server/libs](https://github.com/The-Documentation-Compendium/tree/master/frontend/server/libs): Libraries and 
 6 | utilities.
 7 | + [frontend/server/libs/dao](https://github.com/The-Documentation-Compendium/tree/master/frontend/server/libs/dao): Data 
 8 | Access Objects [DAO] and Value Objects [VO]. Classes used to represent database schemes and facilitate their use by the controllers.
 9 | + [frontend/templates](https://github.com/The-Documentation-Compendium/tree/master/frontend/templates): Smarty templates 
10 | used to generate the HTML that is displayed to users.
11 | + [frontend/www](https://github.com/The-Documentation-Compendium/tree/master/frontend/www): The complete contents of the 
12 | Internet page.
13 | 
14 | ### frontend / www
15 | Content:
16 | 
17 | + js /
18 | + css /
19 | 
20 | #### js
21 | As the name implies, here is where all the javascript fonts and javascript frameworks reside. When you want to make changes, please minify the javascript and then upload.
22 | 
23 | #### css
24 | Similar to js, here are the minified css files.
25 | 
26 | ### frontend / server
27 | Content:
28 | 
29 | * dao /
30 | * controllers /
31 | 
32 | None of these modules should be accessible to the outside world. The only one that can call them is the user interface. That's why they're under the www folder.
33 | 
34 | #### DAO / VO
35 | 
36 | The *dao* folder contains the classes for the data access layer. It has 2 things to know: *data access objects* and *value objects*. The *value objects* (VO) are nothing much but classes that are mapped directly to each of the tables in the database. Therefore, there is a class in there called Users, since there is a table with the same name. This class has its setters and getters for each of the fields in the database. The *data access objects* (dao) are static classes for each of the tables, and they serve to obtain and make the objects persistent *vo*.
37 | 
38 | [Here is more info about this model](http://www.ibm.com/developerworks/java/library/j-dao/)
39 | 
40 | #### Controllers
41 | The controllers are where the decisions are made. The controller uses the dao's and vo's to make decisions, and never call the database directly. This way, we avoid having separate controllers for each module of the project.
42 | 


--------------------------------------------------------------------------------
/en/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, sex characteristics, gender identity and expression,
 9 | level of experience, education, socio-economic status, nationality, personal
10 | appearance, race, religion, or sexual identity and 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 kylelobo20@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 https://www.contributor-covenant.org/version/1/4/code-of-conduct.html
72 | 
73 | [homepage]: https://www.contributor-covenant.org
74 | 
75 | For answers to common questions about this code of conduct, see
76 | https://www.contributor-covenant.org/faq
77 | 


--------------------------------------------------------------------------------
/en/CODING_GUIDELINES.md:
--------------------------------------------------------------------------------
 1 | # Coding Guidelines
 2 | 
 3 | - You can validate that your code complies with these guidelines by running `stuff/php-format.py validate`
 4 | - Tabs, no spaces
 5 | - End of line should should be Unix style (`\n`), not Windows style (`\r\n`)
 6 | - Opening brackets goes in the same line as the last statement
 7 | ```
 8 |     if (condition) {
 9 |         stuff;
10 |     }
11 | ```
12 | - A space between keywords and parenthesis for: `if`, `else`, `while`, `switch`, `catch`, `function`
13 | - Function calls have no space before the parentheses
14 | - No spaces are left inside the parentheses
15 | - A space after each comma, but without space before
16 | - All binary operators must have one space before and one after
17 | - There should not be more than one contiguous blank line
18 | - There should be no empty comments
19 | - You should not use block comments `/ * ... * /`, only line `// ...`
20 | - Changes in functionality must be accompanied by their respective new / modified tests
21 | - Exceptions must be used to report erroneous states. The use of functions that return true / false is allowed when they are expected values
22 | - Use [RAII] (http://en.wikipedia.org/wiki/Resource_Acquisition_Is_Initialization) when appropriate, mainly in the administration of resources (files, etc ...)
23 | 


--------------------------------------------------------------------------------
/en/CONTRIBUTING.md:
--------------------------------------------------------------------------------
 1 | # Contributing Guide
 2 | 
 3 | - Contributing to The Documentation Compendium is fairly easy. This document shows you how to get started
 4 | 
 5 | ## General
 6 | - The [Codebase Structure](./CODEBASE_STRUCTURE.md) has detailed information about how the various files in this project are structured
 7 | - Please ensure that any changes you make are in accordance with the [Coding Guidelines](./CODING_GUIDELINES.md) of this repo
 8 | 
 9 | ## Submitting changes
10 | 
11 | - Fork the repo
12 |   - <https://github.com/kylelobo/The-Documentation-Compendium/fork>
13 | - Check out a new branch based and name it to what you intend to do:
14 |   - Example:
15 |     ````
16 |     $ git checkout -b BRANCH_NAME
17 |     ````
18 |     If you get an error, you may need to fetch fooBar first by using
19 |     ````
20 |     $ git remote update && git fetch
21 |     ````
22 |   - Use one branch per fix / feature
23 | - Commit your changes
24 |   - Please provide a git message that explains what you've done
25 |   - Please make sure your commits follow the [conventions](https://gist.github.com/robertpainsi/b632364184e70900af4ab688decf6f53#file-commit-message-guidelines-md)
26 |   - Commit to the forked repository
27 |   - Example:
28 |     ````
29 |     $ git commit -am 'Add some fooBar'
30 |     ````
31 | - Push to the branch
32 |   - Example:
33 |     ````
34 |     $ git push origin BRANCH_NAME
35 |     ````
36 | - Make a pull request
37 |   - Make sure you send the PR to the <code>fooBar</code> branch
38 |   - Travis CI is watching you!
39 | 
40 | If you follow these instructions, your PR will land pretty safely in the main repo!
41 | 


--------------------------------------------------------------------------------
/en/ISSUE_TEMPLATES/bug_report.md:
--------------------------------------------------------------------------------
 1 | ---
 2 | name: Bug report
 3 | about: Create a report to help us improve
 4 | title: ''
 5 | labels: ''
 6 | assignees: ''
 7 | 
 8 | ---
 9 | 
10 | **Describe the bug**
11 | A clear and concise description of what the bug is.
12 | 
13 | **To Reproduce**
14 | Steps to reproduce the behavior:
15 | 1. Go to '...'
16 | 2. Click on '....'
17 | 3. Scroll down to '....'
18 | 4. See error
19 | 
20 | **Expected behavior**
21 | A clear and concise description of what you expected to happen.
22 | 
23 | **Screenshots**
24 | If applicable, add screenshots to help explain your problem.
25 | 
26 | **Desktop (please complete the following information):**
27 |  - OS: [e.g. iOS]
28 |  - Browser [e.g. chrome, safari]
29 |  - Version [e.g. 22]
30 | 
31 | **Smartphone (please complete the following information):**
32 |  - Device: [e.g. iPhone6]
33 |  - OS: [e.g. iOS8.1]
34 |  - Browser [e.g. stock browser, safari]
35 |  - Version [e.g. 22]
36 | 
37 | **Additional context**
38 | Add any other context about the problem here.
39 | 


--------------------------------------------------------------------------------
/en/ISSUE_TEMPLATES/custom.md:
--------------------------------------------------------------------------------
 1 | ---
 2 | name: Custom issue template
 3 | about: Describe this issue template's purpose here.
 4 | title: ''
 5 | labels: ''
 6 | assignees: ''
 7 | 
 8 | ---
 9 | 
10 | 
11 | 


--------------------------------------------------------------------------------
/en/ISSUE_TEMPLATES/feature_request.md:
--------------------------------------------------------------------------------
 1 | ---
 2 | name: Feature request
 3 | about: Suggest an idea for this project
 4 | title: ''
 5 | labels: ''
 6 | assignees: ''
 7 | 
 8 | ---
 9 | 
10 | **Is your feature request related to a problem? Please describe.**
11 | A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
12 | 
13 | **Describe the solution you'd like**
14 | A clear and concise description of what you want to happen.
15 | 
16 | **Describe alternatives you've considered**
17 | A clear and concise description of any alternative solutions or features you've considered.
18 | 
19 | **Additional context**
20 | Add any other context or screenshots about the feature request here.
21 | 


--------------------------------------------------------------------------------
/en/PULL_REQUEST_TEMPLATE.md:
--------------------------------------------------------------------------------
 1 | ### Your checklist for this pull request
 2 | 🚨 Please review the [guidelines for contributing](./CONTRIBUTING.md) to this repository.
 3 | 
 4 | - [ ] Make sure you are requesting to **pull a topic/feature/bugfix branch** (right side). Don't request your master!
 5 | - [ ] Make sure you are making a pull request against the **fooBar branch** (left side).
 6 | - [ ] Check the commit's or even all commits' message styles matches our requested structure.
 7 | - [ ] Check your code additions will fail neither code linting checks nor unit test.
 8 | 
 9 | ### Description
10 | Please describe your pull request.
11 | 
12 | ❤️ Thank you!
13 | 


--------------------------------------------------------------------------------
/en/README_TEMPLATES/Bot.md:
--------------------------------------------------------------------------------
  1 | <p align="center">
  2 |   <a href="" rel="noopener">
  3 |  <img width=200px height=200px src="https://i.imgur.com/FxL5qM0.jpg" alt="Bot logo"></a>
  4 | </p>
  5 | 
  6 | <h3 align="center">Bot Name</h3>
  7 | 
  8 | <div align="center">
  9 | 
 10 |   [![Status](https://img.shields.io/badge/status-active-success.svg)]()
 11 |   [![Platform](https://img.shields.io/badge/platform-reddit-orange.svg)](https://www.reddit.com/user/Wordbook_Bot)
 12 |   [![GitHub Issues](https://img.shields.io/github/issues/kylelobo/The-Documentation-Compendium.svg)](https://github.com/kylelobo/The-Documentation-Compendium/issues)
 13 |   [![GitHub Pull Requests](https://img.shields.io/github/issues-pr/kylelobo/The-Documentation-Compendium.svg)](https://github.com/kylelobo/The-Documentation-Compendium/pulls)
 14 |   [![License](https://img.shields.io/badge/license-MIT-blue.svg)](/LICENSE)
 15 | 
 16 | </div>
 17 | 
 18 | ---
 19 | 
 20 | <p align="center"> 🤖 Few lines describing what your bot does.
 21 |     <br> 
 22 | </p>
 23 | 
 24 | ## 📝 Table of Contents
 25 | + [About](#about)
 26 | + [Demo / Working](#demo)
 27 | + [How it works](#working)
 28 | + [Usage](#usage)
 29 | + [Getting Started](#getting_started)
 30 | + [Deploying your own bot](#deployment)
 31 | + [Built Using](#built_using)
 32 | + [TODO](../TODO.md)
 33 | + [Contributing](../CONTRIBUTING.md)
 34 | + [Authors](#authors)
 35 | + [Acknowledgments](#acknowledgement)
 36 | 
 37 | ## 🧐 About <a name = "about"></a>
 38 | Write about 1-2 paragraphs describing the purpose of your bot.
 39 | 
 40 | ## 🎥 Demo / Working <a name = "demo"></a>
 41 | ![Working](https://media.giphy.com/media/20NLMBm0BkUOwNljwv/giphy.gif)
 42 | 
 43 | ## 💭 How it works <a name = "working"></a>
 44 | 
 45 | The bot first extracts the word from the comment and then fetches word definitions, part of speech, example and source from the Oxford Dictionary API.
 46 | 
 47 | If the word does not exist in the Oxford Dictionary, the Oxford API then returns a 404 response upon which the bot then tries to fetch results form the Urban Dictionary API.
 48 | 
 49 | The bot uses the Pushshift API to fetch comments, PRAW module to reply to comments and Heroku as a server.
 50 | 
 51 | The entire bot is written in Python 3.6
 52 | 
 53 | ## 🎈 Usage <a name = "usage"></a>
 54 | 
 55 | To use the bot, type:
 56 | ```
 57 | !dict word
 58 | ```
 59 | The first part, i.e. "!dict" **is not** case sensitive.
 60 | 
 61 | The bot will then give you the Oxford Dictionary (or Urban Dictionary; if the word does not exist in the Oxford Dictionary) definition of the word as a comment reply.
 62 | 
 63 | ### Example:
 64 | 
 65 | > !dict what is love
 66 | 
 67 | **Definition:**
 68 | 
 69 | Baby, dont hurt me~
 70 | Dont hurt me~ no more.
 71 | 
 72 | **Example:**
 73 | 
 74 | Dude1: Bruh, what is love?
 75 | Dude2: Baby, dont hurt me, dont hurt me- no more!
 76 | Dude1: dafuq?
 77 | 
 78 | **Source:** https://www.urbandictionary.com/define.php?term=what%20is%20love
 79 | 
 80 | ---
 81 | 
 82 | <sup>Beep boop. I am a bot. If there are any issues, contact my [Master](https://www.reddit.com/message/compose/?to=PositivePlayer1&subject=/u/Wordbook_Bot)</sup>
 83 | 
 84 | <sup>Want to make a similar reddit bot? Check out: [GitHub](https://github.com/kylelobo/Reddit-Bot)</sup>
 85 | 
 86 | ## 🏁 Getting Started <a name = "getting_started"></a>
 87 | These instructions will get you a copy of the project up and running on your local machine for development and testing purposes. See [deployment](#deployment) for notes on how to deploy the project on a live system.
 88 | 
 89 | ### Prerequisites
 90 | 
 91 | What things you need to install the software and how to install them.
 92 | 
 93 | ```
 94 | Give examples
 95 | ```
 96 | 
 97 | ### Installing
 98 | 
 99 | A step by step series of examples that tell you how to get a development env running.
100 | 
101 | Say what the step will be
102 | 
103 | ```
104 | Give the example
105 | ```
106 | 
107 | And repeat
108 | 
109 | ```
110 | until finished
111 | ```
112 | 
113 | End with an example of getting some data out of the system or using it for a little demo.
114 | 
115 | ## 🚀 Deploying your own bot <a name = "deployment"></a>
116 | To see an example project on how to deploy your bot, please see my own configuration:
117 | 
118 | + **Heroku**: https://github.com/kylelobo/Reddit-Bot#deploying_the_bot
119 | 
120 | ## ⛏️ Built Using <a name = "built_using"></a>
121 | + [PRAW](https://praw.readthedocs.io/en/latest/) - Python Reddit API Wrapper
122 | + [Heroku](https://www.heroku.com/) - SaaS hosting platform
123 | 
124 | ## ✍️ Authors <a name = "authors"></a>
125 | + [@kylelobo](https://github.com/kylelobo) - Idea & Initial work
126 | 
127 | See also the list of [contributors](https://github.com/kylelobo/The-Documentation-Compendium/contributors) who participated in this project.
128 | 
129 | ## 🎉 Acknowledgements <a name = "acknowledgement"></a>
130 | + Hat tip to anyone whose code was used
131 | + Inspiration
132 | + References
133 | 


--------------------------------------------------------------------------------
/en/README_TEMPLATES/Hackathon.md:
--------------------------------------------------------------------------------
  1 | <p align="center">
  2 |   <a href="" rel="noopener">
  3 |  <img src="https://i.imgur.com/AZ2iWek.png" alt="Project logo"></a>
  4 | </p>
  5 | <h3 align="center">Project Title</h3>
  6 | 
  7 | <div align="center">
  8 | 
  9 |   [![Hackathon](https://img.shields.io/badge/hackathon-name-orange.svg)](http://hackathon.url.com) 
 10 |   [![Status](https://img.shields.io/badge/status-active-success.svg)]() 
 11 |   [![GitHub Issues](https://img.shields.io/github/issues/kylelobo/The-Documentation-Compendium.svg)](https://github.com/kylelobo/The-Documentation-Compendium/issues)
 12 |   [![GitHub Pull Requests](https://img.shields.io/github/issues-pr/kylelobo/The-Documentation-Compendium.svg)](https://github.com/kylelobo/The-Documentation-Compendium/pulls)
 13 |   [![License](https://img.shields.io/badge/license-MIT-blue.svg)](LICENSE.md)
 14 | 
 15 | </div>
 16 | 
 17 | ---
 18 | 
 19 | <p align="center"> Few lines describing your project.
 20 |     <br> 
 21 | </p>
 22 | 
 23 | ## 📝 Table of Contents
 24 | - [Problem Statement](#problem_statement)
 25 | - [Idea / Solution](#idea)
 26 | - [Dependencies / Limitations](#limitations)
 27 | - [Future Scope](#future_scope)
 28 | - [Setting up a local environment](#getting_started)
 29 | - [Usage](#usage)
 30 | - [Technology Stack](#tech_stack)
 31 | - [Contributing](../CONTRIBUTING.md)
 32 | - [Authors](#authors)
 33 | - [Acknowledgments](#acknowledgments)
 34 | 
 35 | ## 🧐 Problem Statement <a name = "problem_statement"></a>
 36 | It is useful to design and follow a specific format when writing a problem statement. While there are several options
 37 | for doing this, the following is a simple and straightforward template often used in Business Analysis to maintain
 38 | focus on defining the problem.
 39 | 
 40 | - IDEAL: This section is used to describe the desired or “to be” state of the process or product. At large, this section 
 41 | should illustrate what the expected environment would look like once the solution is implemented.
 42 | - REALITY: This section is used to describe the current or “as is” state of the process or product. 
 43 | - CONSEQUENCES: This section is used to describe the impacts on the business if the problem is not fixed or improved upon.
 44 | This includes costs associated with loss of money, time, productivity, competitive advantage, and so forth.
 45 | 
 46 | Following this format will result in a workable document that can be used to understand the problem and elicit
 47 | requirements that will lead to a winning solution. 
 48 | 
 49 | ## 💡 Idea / Solution <a name = "idea"></a>
 50 | This section is used to describe potential solutions. 
 51 | 
 52 | Once the ideal, reality, and consequences sections have been 
 53 | completed, and understood, it becomes easier to provide a solution for solving the problem.
 54 | 
 55 | ## ⛓️ Dependencies / Limitations <a name = "limitations"></a>
 56 | - What are the dependencies of your project?
 57 | - Describe each limitation in detailed but concise terms
 58 | - Explain why each limitation exists
 59 | - Provide the reasons why each limitation could not be overcome using the method(s) chosen to acquire.
 60 | - Assess the impact of each limitation in relation to the overall findings and conclusions of your project, and if 
 61 | appropriate, describe how these limitations could point to the need for further research.
 62 | 
 63 | ## 🚀 Future Scope <a name = "future_scope"></a>
 64 | Write about what you could not develop during the course of the Hackathon; and about what your project can achieve 
 65 | in the future.
 66 | 
 67 | ## 🏁 Getting Started <a name = "getting_started"></a>
 68 | These instructions will get you a copy of the project up and running on your local machine for development 
 69 | and testing purposes. See [deployment](#deployment) for notes on how to deploy the project on a live system.
 70 | 
 71 | ### Prerequisites
 72 | 
 73 | What things you need to install the software and how to install them.
 74 | 
 75 | ```
 76 | Give examples
 77 | ```
 78 | 
 79 | ### Installing
 80 | 
 81 | A step by step series of examples that tell you how to get a development env running.
 82 | 
 83 | Say what the step will be
 84 | 
 85 | ```
 86 | Give the example
 87 | ```
 88 | 
 89 | And repeat
 90 | 
 91 | ```
 92 | until finished
 93 | ```
 94 | 
 95 | ## 🎈 Usage <a name="usage"></a>
 96 | Add notes about how to use the system.
 97 | 
 98 | ## ⛏️ Built With <a name = "tech_stack"></a>
 99 | - [MongoDB](https://www.mongodb.com/) - Database
100 | - [Express](https://expressjs.com/) - Server Framework
101 | - [VueJs](https://vuejs.org/) - Web Framework
102 | - [NodeJs](https://nodejs.org/en/) - Server Environment
103 | 
104 | ## ✍️ Authors <a name = "authors"></a>
105 | - [@kylelobo](https://github.com/kylelobo) - Idea & Initial work
106 | 
107 | See also the list of [contributors](https://github.com/kylelobo/The-Documentation-Compendium/contributors) 
108 | who participated in this project.
109 | 
110 | ## 🎉 Acknowledgments <a name = "acknowledgments"></a>
111 | - Hat tip to anyone whose code was used
112 | - Inspiration
113 | - References
114 | 


--------------------------------------------------------------------------------
/en/README_TEMPLATES/IoT.md:
--------------------------------------------------------------------------------
1 | TODO
2 | 


--------------------------------------------------------------------------------
/en/README_TEMPLATES/Minimal.md:
--------------------------------------------------------------------------------
 1 | # Project Title
 2 | 
 3 | ## Table of Contents
 4 | + [About](#about)
 5 | + [Getting Started](#getting_started)
 6 | + [Usage](#usage)
 7 | + [Contributing](../CONTRIBUTING.md)
 8 | 
 9 | ## About <a name = "about"></a>
10 | Write about 1-2 paragraphs describing the purpose of your project.
11 | 
12 | ## Getting Started <a name = "getting_started"></a>
13 | These instructions will get you a copy of the project up and running on your local machine for development and testing purposes. See [deployment](#deployment) for notes on how to deploy the project on a live system.
14 | 
15 | ### Prerequisites
16 | 
17 | What things you need to install the software and how to install them.
18 | 
19 | ```
20 | Give examples
21 | ```
22 | 
23 | ### Installing
24 | 
25 | A step by step series of examples that tell you how to get a development env running.
26 | 
27 | Say what the step will be
28 | 
29 | ```
30 | Give the example
31 | ```
32 | 
33 | And repeat
34 | 
35 | ```
36 | until finished
37 | ```
38 | 
39 | End with an example of getting some data out of the system or using it for a little demo.
40 | 
41 | ## Usage <a name = "usage"></a>
42 | 
43 | Add notes about how to use the system.
44 | 


--------------------------------------------------------------------------------
/en/README_TEMPLATES/README.md:
--------------------------------------------------------------------------------
 1 | ### This folder contains various README Templates that one can use based on the type of project.
 2 | 
 3 | 1. [Minimal.md](./Minimal.md) - Quickly set up a very basic, minimal README for your project.
 4 | 2. [Standard.md](./Standard.md) - A detailed, comprehensive template that covers all the major aspects 
 5 | of a README. 
 6 | 3. [Hackathon.md](./Hackathon.md) - At a Hackathon and quickly need to set up a beautiful, thorough
 7 | README that leaves a lasting impression on the judges? This is the template for you!
 8 | 4. [Bot.md](./Bot.md) - If you have an awesome Bot that you want to share with others.
 9 | 5. [IoT.md](./IoT.md) - This repo nails down the nitty-gritties that go into documenting an IoT project.
10 | 


--------------------------------------------------------------------------------
/en/README_TEMPLATES/Standard.md:
--------------------------------------------------------------------------------
  1 | <p align="center">
  2 |   <a href="" rel="noopener">
  3 |  <img width=200px height=200px src="https://i.imgur.com/6wj0hh6.jpg" alt="Project logo"></a>
  4 | </p>
  5 | 
  6 | <h3 align="center">Project Title</h3>
  7 | 
  8 | <div align="center">
  9 | 
 10 |   [![Status](https://img.shields.io/badge/status-active-success.svg)]() 
 11 |   [![GitHub Issues](https://img.shields.io/github/issues/kylelobo/The-Documentation-Compendium.svg)](https://github.com/kylelobo/The-Documentation-Compendium/issues)
 12 |   [![GitHub Pull Requests](https://img.shields.io/github/issues-pr/kylelobo/The-Documentation-Compendium.svg)](https://github.com/kylelobo/The-Documentation-Compendium/pulls)
 13 |   [![License](https://img.shields.io/badge/license-MIT-blue.svg)](/LICENSE)
 14 | 
 15 | </div>
 16 | 
 17 | ---
 18 | 
 19 | <p align="center"> Few lines describing your project.
 20 |     <br> 
 21 | </p>
 22 | 
 23 | ## 📝 Table of Contents
 24 | - [About](#about)
 25 | - [Getting Started](#getting_started)
 26 | - [Deployment](#deployment)
 27 | - [Usage](#usage)
 28 | - [Built Using](#built_using)
 29 | - [TODO](../TODO.md)
 30 | - [Contributing](../CONTRIBUTING.md)
 31 | - [Authors](#authors)
 32 | - [Acknowledgments](#acknowledgement)
 33 | 
 34 | ## 🧐 About <a name = "about"></a>
 35 | Write about 1-2 paragraphs describing the purpose of your project.
 36 | 
 37 | ## 🏁 Getting Started <a name = "getting_started"></a>
 38 | These instructions will get you a copy of the project up and running on your local machine for development and testing purposes. See [deployment](#deployment) for notes on how to deploy the project on a live system.
 39 | 
 40 | ### Prerequisites
 41 | What things you need to install the software and how to install them.
 42 | 
 43 | ```
 44 | Give examples
 45 | ```
 46 | 
 47 | ### Installing
 48 | A step by step series of examples that tell you how to get a development env running.
 49 | 
 50 | Say what the step will be
 51 | 
 52 | ```
 53 | Give the example
 54 | ```
 55 | 
 56 | And repeat
 57 | 
 58 | ```
 59 | until finished
 60 | ```
 61 | 
 62 | End with an example of getting some data out of the system or using it for a little demo.
 63 | 
 64 | ## 🔧 Running the tests <a name = "tests"></a>
 65 | Explain how to run the automated tests for this system.
 66 | 
 67 | ### Break down into end to end tests
 68 | Explain what these tests test and why
 69 | 
 70 | ```
 71 | Give an example
 72 | ```
 73 | 
 74 | ### And coding style tests
 75 | Explain what these tests test and why
 76 | 
 77 | ```
 78 | Give an example
 79 | ```
 80 | 
 81 | ## 🎈 Usage <a name="usage"></a>
 82 | Add notes about how to use the system.
 83 | 
 84 | ## 🚀 Deployment <a name = "deployment"></a>
 85 | Add additional notes about how to deploy this on a live system.
 86 | 
 87 | ## ⛏️ Built Using <a name = "built_using"></a>
 88 | - [MongoDB](https://www.mongodb.com/) - Database
 89 | - [Express](https://expressjs.com/) - Server Framework
 90 | - [VueJs](https://vuejs.org/) - Web Framework
 91 | - [NodeJs](https://nodejs.org/en/) - Server Environment
 92 | 
 93 | ## ✍️ Authors <a name = "authors"></a>
 94 | - [@kylelobo](https://github.com/kylelobo) - Idea & Initial work
 95 | 
 96 | See also the list of [contributors](https://github.com/kylelobo/The-Documentation-Compendium/contributors) who participated in this project.
 97 | 
 98 | ## 🎉 Acknowledgements <a name = "acknowledgement"></a>
 99 | - Hat tip to anyone whose code was used
100 | - Inspiration
101 | - References
102 | 


--------------------------------------------------------------------------------
/en/TODO.md:
--------------------------------------------------------------------------------
 1 | ### TODO
 2 | 
 3 | ---
 4 | 
 5 | - [x] Document the README.md file in the [README_TEMPLATES](./README_TEMPLATES) folder.
 6 | - [ ] Make an IoT template (Refer to the various Arduino project documentations for assistance). This template must be detailed and should go in-depth into the various hardware terminologies.
 7 | - [ ] Make a minimal IoT template.
 8 | - [ ] Add a COMMIT_MESSAGE_GUIDELINES.md file.
 9 | - [ ] Translate the [templates](https://github.com/kylelobo/The-Documentation-Compendium#templates) into different languages - Chinese, French, German, Hindi, Italian, Japanese, Korean, Portuguese, Russian, Spanish, etc.
10 | 
11 | 


--------------------------------------------------------------------------------
/es/CHANGELOG.md:
--------------------------------------------------------------------------------
 1 | # Registro de cambios
 2 | 
 3 | Todos los cambios notables de este proyecto se documentarán en este archivo.
 4 | 
 5 | El formato se basa en [Keep a Changelog](http://keepachangelog.com/)
 6 | y este proyecto se adhiere a [Semantic Versioning](http://semver.org/).
 7 | 
 8 | ## [Inédito]: aaaa-mm-dd
 9 | 
10 | Aquí escribimos notas de actualización para las marcas. Es un esfuerzo de equipo hacerlos como
11 | lo más sencillo posible.
12 | 
13 | ### Agregado
14 | 
15 | - [PROJECTNAME-XXXX](http://tickets.projectname.com/browse/PROJECTNAME-XXXX)
16 |   MENOR El título de la entrada va aquí.
17 | - [PROJECTNAME-YYYY](http://tickets.projectname.com/browse/PROJECTNAME-YYYY)
18 |   PATCH El título del ticket va aquí.
19 | 
20 | ### Cambió
21 | 
22 | ### Reparado
23 | 
24 | ## [1.2.4] - 2017-03-15
25 |   
26 | Aquí tendríamos los pasos de actualización para 1.2.4 para que la gente los siga.
27 | 
28 | ### Agregado
29 | 
30 | ### Cambió
31 |   
32 | - [PROJECTNAME-ZZZZ](http://tickets.projectname.com/browse/PROJECTNAME-ZZZZ)
33 |   PATCH Drupal.org ahora se usa como compositor.
34 | 
35 | ### Reparado
36 | 
37 | - [PROJECTNAME-TTTT](http://tickets.projectname.com/browse/PROJECTNAME-TTTT)
38 |   PARCHE Agregue lógica al avance de la hoja de ejecución eliminar para eliminar el correspondiente
39 |   tarjetas de horario.
40 | 
41 | ## [1.2.3] - 2017-03-14
42 | 
43 | ### Agregado
44 | 
45 | ### Cambió
46 | 
47 | ### Reparado
48 | 
49 | - [PROJECTNAME-UUUU](http://tickets.projectname.com/browse/PROJECTNAME-UUUU)
50 |   Pruebas de foo del módulo de reparación MENOR
51 | - [PROJECTNAME-RRRR](http://tickets.projectname.com/browse/PROJECTNAME-RRRR)
52 |   La línea de tiempo del módulo PRINCIPAL de foo usa la zona horaria del navegador para la resolución de la fecha


--------------------------------------------------------------------------------
/es/CODEBASE_STRUCTURE.md:
--------------------------------------------------------------------------------
 1 | Estos son los directorios que estamos utilizando activamente en el desarrollo:
 2 | 
 3 | + [frontend / server / controllers](https://github.com/kylelobo/The-Documentation-Compendium/tree/master/frontend/server/controllers):
 4 | Los controladores hacen la lógica empresarial y exponen la API del servidor.
 5 | + [frontend / server / libs](https://github.com/The-Documentation-Compendium/tree/master/frontend/server/libs): Bibliotecas y utilidades.
 6 | + [frontend / server / libs / dao](https://github.com/The-Documentation-Compendium/tree/master/frontend/server/libs/dao): Objetos de Acceso de Datos [DAO] y Objetos de valor [VO]. Clases utilizadas para representar esquemas de bases de datos y facilitar su uso por parte de los controladores.
 7 | + [frontend / templates](https://github.com/The-Documentation-Compendium/tree/master/frontend/templates): plantillas de Smarty utilizado para generar el HTML que se muestra a los usuarios.
 8 | + [frontend / www](https://github.com/The-Documentation-Compendium/tree/master/frontend/www): el contenido completo de la
 9 | página de Internet.
10 | 
11 | ### frontend / www
12 | 
13 | Contenido:
14 | 
15 | + js /
16 | + css /
17 | 
18 | #### js
19 | 
20 | Como su nombre lo indica, aquí es donde residen todas las fuentes y marcos de JavaScript. Cuando desee realizar cambios, minimice el javascript y luego cárguelo.
21 | 
22 | #### css
23 | 
24 | Similar a js, aquí están los archivos css minificados.
25 | 
26 | ### frontend / servidor
27 | 
28 | Contenido:
29 | 
30 | + dao /
31 | + controladores /
32 | 
33 | Ninguno de estos módulos debería ser accesible para el mundo exterior. El único que puede llamarlos es la interfaz de usuario. Por eso están en la carpeta www.
34 | 
35 | #### DAO / VO
36 | 
37 | La carpeta *dao* contiene las clases para la capa de acceso a datos. Tiene 2 cosas que saber: *objetos de acceso a datos* y *objetos de valor*. Los *objetos de valor* (VO) no son más que clases que se asignan directamente a cada una de las tablas de la base de datos. Por lo tanto, hay una clase allí llamada Usuarios, ya que hay una tabla con el mismo nombre. Esta clase tiene sus establecedores y captadores para cada uno de los campos de la base de datos. Los *objetos de acceso a datos* (dao) son clases estáticas para cada una de las tablas, y sirven para obtener y hacer persistentes los objetos *vo*.
38 | 
39 | [Aquí hay más información sobre este modelo](http://www.ibm.com/developerworks/java/library/j-dao/)
40 | 
41 | #### Controladores
42 | 
43 | Los controladores son donde se toman las decisiones. El controlador usa los dao's y vo's para tomar decisiones y nunca llama directamente a la base de datos. De esta forma, evitamos tener controladores separados para cada módulo del proyecto.
44 | 


--------------------------------------------------------------------------------
/es/CODE_OF_CONDUCT.md:
--------------------------------------------------------------------------------
 1 | # Código de conducta del colaborador
 2 | 
 3 | ## Nuestro compromiso
 4 | 
 5 | Con el fin de fomentar un entorno abierto y acogedor, como
 6 | contribuyentes y mantenedores se comprometen a participar en nuestro proyecto y
 7 | nuestra comunidad una experiencia libre de acoso para todos, independientemente de su edad, cuerpo
 8 | tamaño, discapacidad, etnia, características sexuales, identidad y expresión de género,
 9 | nivel de experiencia, educación, situación socioeconómica, nacionalidad, personal
10 | apariencia, raza, religión o identidad y orientación sexual.
11 | 
12 | ## Nuestros estándares
13 | 
14 | Ejemplos de comportamiento que contribuye a crear un entorno positivo.
15 | incluir:
16 | 
17 | * Usar un lenguaje acogedor e inclusivo
18 | * Respetar los diferentes puntos de vista y experiencias.
19 | * Aceptando con gracia las críticas constructivas
20 | * Centrarse en lo que es mejor para la comunidad
21 | * Mostrar empatía hacia otros miembros de la comunidad
22 | 
23 | Ejemplos de comportamiento inaceptable por parte de los participantes incluyen:
24 | 
25 | * El uso de lenguaje o imágenes sexualizadas y atención o atención sexual no deseada.
26 |  avances
27 | * Trolling, comentarios insultantes / despectivos y ataques personales o políticos
28 | * Acoso público o privado
29 | * Publicar información privada de otros, como una información física o electrónica.
30 |  dirección, sin permiso explícito
31 | * Otra conducta que razonablemente podría considerarse inapropiada en un
32 |  entorno profesional
33 | 
34 | ## Nuestras responsabilidades
35 | 
36 | Los encargados del mantenimiento del proyecto son responsables de aclarar los estándares de
37 | comportamiento y se espera que tomen las acciones correctivas apropiadas y justas en
38 | respuesta a cualquier caso de comportamiento inaceptable.
39 | 
40 | Los encargados del mantenimiento del proyecto tienen el derecho y la responsabilidad de eliminar, editar o
41 | rechazar comentarios, confirmaciones, código, ediciones de wiki, problemas y otras contribuciones
42 | que no están alineados con este Código de Conducta, o para prohibir temporalmente o
43 | de forma permanente cualquier colaborador por otros comportamientos que consideren inapropiados,
44 | amenazante, ofensivo o dañino.
45 | 
46 | ## Alcance
47 | 
48 | Este Código de Conducta se aplica tanto dentro de los espacios del proyecto como en los espacios públicos.
49 | cuando un individuo representa el proyecto o su comunidad. Ejemplos de
50 | representar un proyecto o comunidad incluye el uso de un correo electrónico oficial del proyecto
51 | dirección, publicando a través de una cuenta oficial de redes sociales, o actuando como un designado
52 | representante en un evento en línea o fuera de línea. La representación de un proyecto puede ser
53 | más definido y aclarado por los encargados del mantenimiento del proyecto.
54 | 
55 | ## Ejecución
56 | 
57 | Los casos de comportamiento abusivo, acosador o inaceptable pueden ser
58 | informado poniéndose en contacto con el equipo del proyecto en kylelobo20@gmail.com. Todos
59 | Las quejas serán revisadas e investigadas y resultarán en una respuesta que
60 | se considera necesario y apropiado a las circunstancias. El equipo del proyecto es
61 | obligado a mantener la confidencialidad con respecto al informante de un incidente.
62 | Se pueden publicar más detalles de las políticas de aplicación específicas por separado.
63 | 
64 | Los mantenedores de proyectos que no siguen o hacen cumplir el Código de Conducta de manera adecuada
65 | La fe puede enfrentar repercusiones temporales o permanentes según lo determinen otros
66 | miembros de la dirección del proyecto.
67 | 
68 | ## Atribución
69 | 
70 | Este Código de conducta está adaptado del [Pacto del colaborador] [página de inicio], versión 1.4,
71 | disponible en https://www.contributor-covenant.org/version/1/4/code-of-conduct.html
72 | 
73 | [página de inicio]: https://www.contributor-covenant.org
74 | 
75 | Para obtener respuestas a preguntas comunes sobre este código de conducta, consulte
76 | https://www.contributor-covenant.org/faq


--------------------------------------------------------------------------------
/es/CODING_GUIDELINES.md:
--------------------------------------------------------------------------------
 1 | # Guiá de codificación
 2 | 
 3 | - Puede validar que su código cumpla con estas reglas ejecutando `stuff / php-format.py validate`
 4 | - Tabuladores, sin espacios
 5 | - El final de la línea debe ser estilo Unix (`\n`), no estilo Windows (`\r\n`)
 6 | - Los corchetes de apertura van en la misma línea que la última declaración
 7 | 
 8 | ```
 9 |     if (condición) {
10 |         cosas;
11 |     }
12 | ```
13 | 
14 | - Un espacio entre palabras clave y paréntesis para: `if`,` else`, `while`,` switch`, `catch`,` function`
15 | - Las llamadas a funciones no tienen espacio antes del paréntesis.
16 | - No se dejan espacios entre paréntesis
17 | - Un espacio después de cada coma, pero sin espacio antes
18 | - Todos los operadores binarios deben tener un espacio antes y otro después
19 | - No debe haber más de una línea en blanco contigua
20 | - No debe haber comentarios vacíos.
21 | - No debe usar comentarios de bloque `/ * ... * /`, solo línea `// ...`
22 | - Los cambios en la funcionalidad deben ir acompañados de sus respectivas nuevas/modificadas pruebas
23 | - Se deben utilizar excepciones para informar estados erróneos. Se permite el uso de funciones que devuelven verdadero/falso cuando son valores esperados
24 | - Utilizar [RAII](https://es.wikipedia.org/wiki/RAII) cuando corresponda, principalmente en la administración de recursos (archivos, etc ...)
25 | 


--------------------------------------------------------------------------------
/es/CONTRIBUTING.md:
--------------------------------------------------------------------------------
 1 | # Guía de contribución
 2 | 
 3 | - Contribuir al Compendio de documentación es bastante fácil. Este documento le muestra cómo empezar
 4 | 
 5 | ## General
 6 | 
 7 | - La [Estructura de la base de código] (./ CODEBASE_STRUCTURE.md) tiene información detallada sobre cómo se estructuran los distintos archivos de este proyecto.
 8 | - Asegúrese de que los cambios que realice se ajusten a las [guiás de codificación] (./ CODING_GUIDELINES.md) de este repositorio.
 9 | 
10 | ## Envío de cambios
11 | 
12 | - Bifurcar el repositorio
13 |   - <https://github.com/kylelobo/The-Documentation-Compendium/fork>
14 | - Crea una nueva rama basada en el nombre de lo que pretendes hacer:
15 |   - Ejemplo:
16 | 
17 |     ````console
18 |     $ git checkout -b NOMBRE_RAMA
19 |     ````
20 | 
21 |     Si recibe un error, es posible que primero deba buscar fooBar usando
22 | 
23 |     ````console
24 |     $ git actualización remota && git fetch
25 |     ````
26 | 
27 |   - Use una rama por reparación/característica
28 |   
29 | - Confirma tus cambios
30 |   - Proporcione un mensaje de git que explique lo que ha hecho.
31 |   - Asegúrate de que tus confirmaciones sigan las [convenciones](https://gist.github.com/robertpainsi/b632364184e70900af4ab688decf6f53#file-commit-message-guidelines-md)
32 |   - Envia commit con el repositorio bifurcado
33 |   - Ejemplo:
34 | 
35 |     ````console
36 |     $ git commit -am 'Agregar algo de fooBar'
37 |     ````
38 | 
39 | - Empujar a la rama
40 |   - Ejemplo:
41 | 
42 |     ````console
43 |     $ git push origin BRANCH_NAME
44 |     ````
45 | 
46 | - Hacer un Pull Request
47 |   - Asegúrese de enviar el PR a la rama <code> fooBar </code>
48 |   - ¡Travis CI te está mirando!
49 | 
50 | Si sigue estas instrucciones, su PR aterrizará de forma bastante segura en el repositorio principal.


--------------------------------------------------------------------------------
/es/ISSUE_TEMPLATES/bug_report.md:
--------------------------------------------------------------------------------
 1 | ---
 2 | Nombre: Reporte de error
 3 | Acerca de: Crea un reporte para ayudarnos a mejorar.
 4 | Titulo: ''
 5 | Etiqueta: ''
 6 | Encargados: ''
 7 | 
 8 | ---
 9 | 
10 | **Describe el error**
11 | Una descripción clara y concisa de cuál es el error.
12 | 
13 | **Reproducir**
14 | Pasos para reproducir el comportamiento:
15 | 
16 | 1. Vaya a '...'
17 | 2. Haga clic en '....'
18 | 3. Desplácese hacia abajo hasta '....'
19 | 4. Ver error
20 | 
21 | **Comportamiento esperado**
22 | Una descripción clara y concisa de lo que esperaba que sucediera.
23 | 
24 | **Capturas de pantalla**
25 | Si corresponde, agregue capturas de pantalla para ayudar a explicar su problema.
26 | 
27 | **Escritorio (complete la siguiente información):**
28 | 
29 | - SO: [p. Ej. iOS]
30 | - Navegador [p. Ej. cromo, safari]
31 | - Versión [p. Ej. 22]
32 | 
33 | **Smartphone (complete la siguiente información):**
34 | 
35 | - Dispositivo: [p. Ej. iphone 6]
36 | - SO: [p. Ej. iOS8.1]
37 | - Navegador [p. Ej. navegador de valores, safari]
38 | - Versión [p. Ej. 22]
39 | 
40 | **Contexto adicional**
41 | Agregue aquí cualquier otro contexto sobre el problema.
42 | 


--------------------------------------------------------------------------------
/es/ISSUE_TEMPLATES/custom.md:
--------------------------------------------------------------------------------
1 | ---
2 | Nombre: Solicitud de función personalizada
3 | Acerca de: Describe la función de la solicitud aqui.
4 | Titulo: ''
5 | Etiqueta: ''
6 | Encargados: ''
7 | 
8 | ---


--------------------------------------------------------------------------------
/es/ISSUE_TEMPLATES/feature_request.md:
--------------------------------------------------------------------------------
 1 | ---
 2 | Nombre: Solicitud de función
 3 | Acerca de: Sugiere una idea para este proyecto.
 4 | Titulo: ''
 5 | Etiqueta: ''
 6 | Encargados: ''
 7 | 
 8 | ---
 9 | 
10 | **¿Su solicitud de función está relacionada con un problema? Por favor describa.**
11 | Una descripción clara y concisa de cuál es el problema. Ex. Siempre me frustra cuando [...]
12 | 
13 | **Describe la solución que te gustaría**
14 | Una descripción clara y concisa de lo que quieres que suceda.
15 | 
16 | **Describe las alternativas que has considerado**
17 | Una descripción clara y concisa de cualquier solución o característica alternativa que haya considerado.
18 | 
19 | **Contexto adicional**
20 | Agregue cualquier otro contexto o capturas de pantalla sobre la solicitud de función aquí.
21 | 


--------------------------------------------------------------------------------
/es/PULL_REQUEST_TEMPLATE.md:
--------------------------------------------------------------------------------
 1 | ### Tu lista de verificación para este Pull Request
 2 | 
 3 | 🚨 Revise las [reglas para contribuir](./CONTRIBUTING.md) a este repositorio.
 4 | 
 5 | - [] Asegúrese de que está solicitando **extraer una rama de tema / característica / corrección de errores** (lado derecho). ¡No solicites a tu rama principal!
 6 | - [] Asegúrate de realizar una solicitud de extracción contra la **rama fooBar** (lado izquierdo).
 7 | - [] Verifique que los estilos de mensaje de los commits o incluso de todos los commits coincidan con nuestra estructura solicitada.
 8 | - [] Compruebe que las adiciones de su código no fallarán ni en las comprobaciones de lint del código ni en la pruebas unitarias.
 9 | 
10 | ### Descripción
11 | 
12 | Describe tu solicitud de pull request.
13 | 
14 | ❤️ ¡Gracias!
15 | 


--------------------------------------------------------------------------------
/es/README_TEMPLATES/Bot.md:
--------------------------------------------------------------------------------
  1 | <p align="center">
  2 |   <a href="" rel="noopener">
  3 |  <img width=200px height=200px src="https://i.imgur.com/FxL5qM0.jpg" alt="Bot logo"></a>
  4 | </p>
  5 | 
  6 | <h3 align="center">Nombre del Bot</h3>
  7 | 
  8 | <div align="center">
  9 | 
 10 |   [![Status](https://img.shields.io/badge/status-active-success.svg)]()
 11 |   [![Platform](https://img.shields.io/badge/platform-reddit-orange.svg)](https://www.reddit.com/user/Wordbook_Bot)
 12 |   [![GitHub Issues](https://img.shields.io/github/issues/kylelobo/The-Documentation-Compendium.svg)](https://github.com/kylelobo/The-Documentation-Compendium/issues)
 13 |   [![GitHub Pull Requests](https://img.shields.io/github/issues-pr/kylelobo/The-Documentation-Compendium.svg)](https://github.com/kylelobo/The-Documentation-Compendium/pulls)
 14 |   [![License](https://img.shields.io/badge/license-MIT-blue.svg)](/LICENSE)
 15 | 
 16 | </div>
 17 | 
 18 | ---
 19 | 
 20 | <p align="center"> 🤖 Unas cuantas lineas describiendo que hace el bot.
 21 |     <br>
 22 | </p>
 23 | 
 24 | ## 📝 Tabla de contenido
 25 | - [📝 Tabla de contenido](#-tabla-de-contenido)
 26 | - [🧐 Acerca de <a name = "about"> </a>](#-acerca-de--)
 27 | - [🎥 Demostración <a name = "demo"> </a>](#-demostración--)
 28 | - [💭 Cómo funciona <a name = "working"> </a>](#-cómo-funciona--)
 29 | - [🎈 Uso <a name = "usage"> </a>](#-uso--)
 30 |   - [Ejemplo](#ejemplo)
 31 | - [🏁 Comenzando <a name = "getting_started"> </a>](#-comenzando--)
 32 |   - [Requisitos previos](#requisitos-previos)
 33 |   - [Instalación](#instalación)
 34 | - [🚀 Implementación de su propio bot <a name = "deployment"> </a>](#-implementación-de-su-propio-bot--)
 35 | - [⛏️ Creado con <a name = "built_using"> </a>](#️-creado-con--)
 36 | - [✍️ Autores <a name = "authors"> </a>](#️-autores--)
 37 | - [🎉 Agradecimientos <a name = "acknowledgement"> </a>](#-agradecimientos--)
 38 | 
 39 | ## 🧐 Acerca de <a name = "about"> </a>
 40 | 
 41 | Escribe entre 1 y 2 párrafos que describan el propósito de tu bot.
 42 | 
 43 | ## 🎥 Demostración <a name = "demo"> </a>
 44 | 
 45 | ![En funcionamiento](https://media.giphy.com/media/20NLMBm0BkUOwNljwv/giphy.gif)
 46 | 
 47 | ## 💭 Cómo funciona <a name = "working"> </a>
 48 | 
 49 | El bot primero extrae la palabra del comentario y luego busca definiciones de palabras, parte del discurso, ejemplo y fuente de la API del Diccionario Oxford.
 50 | 
 51 | Si la palabra no existe en el Diccionario Oxford, la API de Oxford devuelve una respuesta 404 en la que el bot intenta obtener resultados de la API del Diccionario Urbano.
 52 | 
 53 | El bot usa la API Pushshift para buscar comentarios, el módulo PRAW para responder a los comentarios y Heroku como servidor.
 54 | 
 55 | Todo el bot está escrito en Python 3.6
 56 | 
 57 | ## 🎈 Uso <a name = "usage"> </a>
 58 | 
 59 | Para usar el bot, escriba:
 60 | 
 61 | ```
 62 | ! dict palabra
 63 | ```
 64 | 
 65 | La primera parte, es decir, "! Dict" ** no distingue entre mayúsculas y minúsculas.
 66 | 
 67 | El bot le dará la definición de la palabra en el Diccionario Oxford (o Urban Dictionary, si la palabra no existe en el Diccionario Oxford) como respuesta a un comentario.
 68 | 
 69 | ### Ejemplo
 70 | 
 71 | >! dict que es el amor
 72 | 
 73 | **Definición:**
 74 | 
 75 | Bebé, no me lastimes ~
 76 | No me hagas daño ~ no más.
 77 | 
 78 | **Ejemplo:**
 79 | 
 80 | Amigo1: Bruh, ¿qué es el amor?
 81 | Dude2: Cariño, no me hagas daño, no me hagas daño, ¡no más!
 82 | Amigo1: ¿dafuq?
 83 | 
 84 | **Fuente:** <https://www.urbandictionary.com/define.php?term=what%20is%20love>
 85 | 
 86 | ---
 87 | 
 88 | <sup> Bip boop. Soy un bot. Si hay algún problema, comuníquese con mi [Maestro](https://www.reddit.com/message/compose/?to=PositivePlayer1&subject=/u/Wordbook_Bot) </sup>
 89 | 
 90 | <sup> ¿Quieres hacer un bot de reddit similar? Echa un vistazo a: [GitHub](https://github.com/kylelobo/Reddit-Bot) </sup>
 91 | 
 92 | ## 🏁 Comenzando <a name = "getting_started"> </a>
 93 | 
 94 | Estas instrucciones le proporcionarán una copia del proyecto en funcionamiento en su máquina local con fines de desarrollo y prueba. Consulte [implementación](#implementación) para obtener notas sobre cómo implementar el proyecto en un sistema en vivo.
 95 | 
 96 | ### Requisitos previos
 97 | 
 98 | Qué necesita para instalar el software y cómo instalarlo.
 99 | 
100 | ```
101 | Dar ejemplos
102 | ```
103 | 
104 | ### Instalación
105 | 
106 | Una serie de ejemplos paso a paso que le indican cómo ejecutar un entorno de desarrollo.
107 | 
108 | Di cuál será el paso
109 | 
110 | ```
111 | Da el ejemplo
112 | ```
113 | 
114 | Y repetir
115 | 
116 | ```
117 | hasta que termine
118 | ```
119 | 
120 | Termine con un ejemplo de cómo sacar algunos datos del sistema o usarlos para una pequeña demostración.
121 | 
122 | ## 🚀 Implementación de su propio bot <a name = "deployment"> </a>
123 | 
124 | Para ver un proyecto de ejemplo sobre cómo implementar su bot, consulte mi propia configuración:
125 | 
126 | + **Heroku**: <https://github.com/kylelobo/Reddit-Bot#deploying_the_bot>
127 | 
128 | ## ⛏️ Creado con <a name = "built_using"> </a>
129 | 
130 | + [PRAW](https://praw.readthedocs.io/en/latest/) - Envoltorio de API de Python Reddit
131 | + [Heroku](https://www.heroku.com/) - Plataforma de alojamiento SaaS
132 | 
133 | ## ✍️ Autores <a name = "authors"> </a>
134 | 
135 | - [@kylelobo](https://github.com/kylelobo) - Idea y trabajo inicial
136 | - [@FanchiniRudolf](https://github.com/FanchiniRudolf) - Traducción al español
137 | 
138 | Consulte también la lista de [contribuyentes](https://github.com/kylelobo/The-Documentation-Compendium/contributors) que participaron en este proyecto.
139 | 
140 | ## 🎉 Agradecimientos <a name = "acknowledgement"> </a>
141 | 
142 | - Apreciación para cualquier persona cuyo código se haya utilizado
143 | - inspiración
144 | - referencias
145 | 


--------------------------------------------------------------------------------
/es/README_TEMPLATES/Hackathon.md:
--------------------------------------------------------------------------------
  1 | <p align="center">
  2 |   <a href="" rel="noopener">
  3 |  <img src="https://i.imgur.com/AZ2iWek.png" alt="Project logo"></a>
  4 | </p>
  5 | <h3 align="center">Titulo del proyecto</h3>
  6 | 
  7 | <div align="center">
  8 | 
  9 |   [![Hackathon](https://img.shields.io/badge/hackathon-name-orange.svg)](http://hackathon.url.com)
 10 |   [![Status](https://img.shields.io/badge/status-active-success.svg)]()
 11 |   [![GitHub Issues](https://img.shields.io/github/issues/kylelobo/The-Documentation-Compendium.svg)](https://github.com/kylelobo/The-Documentation-Compendium/issues)
 12 |   [![GitHub Pull Requests](https://img.shields.io/github/issues-pr/kylelobo/The-Documentation-Compendium.svg)](https://github.com/kylelobo/The-Documentation-Compendium/pulls)
 13 |   [![License](https://img.shields.io/badge/license-MIT-blue.svg)](LICENSE.md)
 14 | 
 15 | </div>
 16 | 
 17 | ---
 18 | <p align = "center"> Pocas líneas que describen su proyecto.
 19 |     <br>
 20 | </p>
 21 | 
 22 | ## 📝 Tabla de contenido
 23 | 
 24 | - [📝 Tabla de contenido](#-tabla-de-contenido)
 25 | - [🧐 Declaración del problema <a name = "problem_statement"> </a>](#-declaración-del-problema--)
 26 | - [💡 Idea / Solución <a name = "idea"> </a>](#-idea--solución--)
 27 | - [⛓️ Dependencias / Limitaciones <a name = "limitations"> </a>](#️-dependencias--limitaciones--)
 28 | - [🚀 Alcance futuro <a name = "future_scope"> </a>](#-alcance-futuro--)
 29 | - [🏁 Comenzando <a name = "getting_started"> </a>](#-comenzando--)
 30 |   - [Requisitos previos](#requisitos-previos)
 31 |   - [Instalación](#instalación)
 32 | - [🎈 Uso <a name="usage"> </a>](#-uso--)
 33 | - [⛏️ Creado con <a name = "tech_stack"> </a>](#️-creado-con--)
 34 | - [✍️ Autores <a name = "authors"> </a>](#️-autores--)
 35 | - [🎉 Agradecimientos <a name = "acknowledgement"> </a>](#-agradecimientos--)
 36 | 
 37 | ## 🧐 Declaración del problema <a name = "problem_statement"> </a>
 38 | 
 39 | Es útil diseñar y seguir un formato específico al escribir una declaración de problema. Si bien hay varias opciones
 40 | Para hacer esto, la siguiente es una plantilla simple y directa que se usa a menudo en Business Analysis para mantener
 41 | céntrese en definir el problema.
 42 | 
 43 | - IDEAL: Esta sección se utiliza para describir el estado deseado o "a ser" del proceso o producto. En general, esta sección
 44 | debe ilustrar cómo se vería el entorno esperado una vez implementada la solución.
 45 | - REALIDAD: Esta sección se utiliza para describir el estado actual o "tal cual" del proceso o producto.
 46 | - CONSECUENCIAS: Esta sección se utiliza para describir los impactos en el negocio si el problema no se soluciona o mejora.
 47 | Esto incluye los costos asociados con la pérdida de dinero, tiempo, productividad, ventaja competitiva, etc.
 48 | 
 49 | Seguir este formato dará como resultado un documento viable que se puede utilizar para comprender el problema y obtener
 50 | requisitos que conducirán a una solución ganadora.
 51 | 
 52 | ## 💡 Idea / Solución <a name = "idea"> </a>
 53 | 
 54 | Esta sección se utiliza para describir posibles soluciones.
 55 | 
 56 | Una vez que las secciones de ideal, realidad y consecuencias han sido
 57 | completado y comprendido, resulta más fácil proporcionar una solución para resolver el problema.
 58 | 
 59 | ## ⛓️ Dependencias / Limitaciones <a name = "limitations"> </a>
 60 | 
 61 | - ¿Cuáles son las dependencias de su proyecto?
 62 | - Describe cada limitación en términos detallados pero concisos.
 63 | - Explica por qué existe cada limitación.
 64 | - Proporcione las razones por las que no se pudo superar cada limitación utilizando el método o métodos elegidos para adquirir.
 65 | - Evalúe el impacto de cada limitación en relación con los hallazgos y conclusiones generales de su proyecto, y si apropiado, describa cómo estas limitaciones podrían indicar la necesidad de realizar más investigaciones.
 66 | 
 67 | ## 🚀 Alcance futuro <a name = "future_scope"> </a>
 68 | 
 69 | Escribe sobre lo que no pudiste desarrollar durante el transcurso del Hackathon; y sobre lo que puede lograr su proyecto en el futuro.
 70 | 
 71 | ## 🏁 Comenzando <a name = "getting_started"> </a>
 72 | 
 73 | Estas instrucciones le proporcionarán una copia del proyecto en funcionamiento en su máquina local para su desarrollo.
 74 | y fines de prueba. Consulte [implementación] (# implementación) para obtener notas sobre cómo implementar el proyecto en un sistema en vivo.
 75 | 
 76 | ### Requisitos previos
 77 | 
 78 | Qué necesita para instalar el software y cómo instalarlo.
 79 | 
 80 | ```
 81 | Dar ejemplos
 82 | ```
 83 | 
 84 | ### Instalación
 85 | 
 86 | Una serie de ejemplos paso a paso que le indican cómo ejecutar un entorno de desarrollo.
 87 | 
 88 | Di cuál será el paso
 89 | 
 90 | ```
 91 | Da el ejemplo
 92 | ```
 93 | 
 94 | Y repetir
 95 | 
 96 | ```
 97 | hasta que termine
 98 | ```
 99 | 
100 | ## 🎈 Uso <a name="usage"> </a>
101 | 
102 | Agregue notas sobre cómo usar el sistema.
103 | 
104 | ## ⛏️ Creado con <a name = "tech_stack"> </a>
105 | 
106 | - [MongoDB](https://www.mongodb.com/) - Base de datos
107 | - [Express](https://expressjs.com/) - Marco del servidor
108 | - [VueJs](https://vuejs.org/) - Marco web
109 | - [NodeJs](https://nodejs.org/en/) - Entorno del servidor
110 | 
111 | ## ✍️ Autores <a name = "authors"> </a>
112 | 
113 | - [@kylelobo](https://github.com/kylelobo) - Idea y trabajo inicial
114 | - [@FanchiniRudolf](https://github.com/FanchiniRudolf) - Traducción al español
115 | 
116 | Consulte también la lista de [contribuyentes](https://github.com/kylelobo/The-Documentation-Compendium/contributors) que participaron en este proyecto.
117 | 
118 | ## 🎉 Agradecimientos <a name = "acknowledgement"> </a>
119 | 
120 | - Apreciación para cualquier persona cuyo código se haya utilizado
121 | - inspiración
122 | - referencias
123 | 


--------------------------------------------------------------------------------
/es/README_TEMPLATES/IoT.md:
--------------------------------------------------------------------------------
1 | TODO
2 | 


--------------------------------------------------------------------------------
/es/README_TEMPLATES/Minimal.md:
--------------------------------------------------------------------------------
 1 | # Título del Proyecto
 2 | 
 3 | ## Tabla de contenido
 4 | 
 5 | + [Acerca de](#about)
 6 | + [Introducción](#getting_started)
 7 | + [Uso](#usage)
 8 | + [Contribuyendo](../CONTRIBUTING.md)
 9 | 
10 | ## Acerca de <a name = "about"> </a>
11 | 
12 | Escribe entre 1 y 2 párrafos que describan el propósito de tu proyecto.
13 | 
14 | ## Comenzando <a name = "getting_started"> </a>
15 | 
16 | Estas instrucciones le proporcionarán una copia del proyecto en funcionamiento en su máquina local con fines de desarrollo y prueba. Consulte [implementación](#implementación) para obtener notas sobre cómo implementar el proyecto en un sistema en vivo.
17 | 
18 | ### Requisitos previos
19 | 
20 | Qué necesita para instalar el software y cómo instalarlo.
21 | 
22 | ```
23 | Dar ejemplos
24 | ```
25 | 
26 | ### Instalación
27 | 
28 | Una serie de ejemplos paso a paso que le indican cómo ejecutar un entorno de desarrollo.
29 | 
30 | Di cuál será el paso
31 | 
32 | ```
33 | Da el ejemplo
34 | ```
35 | 
36 | Y repetir
37 | 
38 | ```
39 | hasta que termine
40 | ```
41 | 
42 | Termine con un ejemplo de cómo sacar algunos datos del sistema o usarlos para una pequeña demostración.
43 | 
44 | ## Uso <a name = "usage"> </a>
45 | 
46 | Agregue notas sobre cómo usar el sistema.
47 | 


--------------------------------------------------------------------------------
/es/README_TEMPLATES/README.md:
--------------------------------------------------------------------------------
1 | ### Esta carpeta contiene varias plantillas README que se pueden utilizar según el tipo de proyecto.
2 | 
3 | 1. [Bot.md](/README%20Templates/Bot.md) - 
4 | 2. [Hackathon.md](/README%20Templates/Hackathon.md) - 
5 | 3. [IoT.md](/README%20Templates/IoT.md) - 
6 | 4. [Minimal.md](/README%20Templates/Minimal.md) - 
7 | 5. [Standard.md](/README%20Templates/Standard.md) - 
8 | 


--------------------------------------------------------------------------------
/es/README_TEMPLATES/Standard.md:
--------------------------------------------------------------------------------
  1 | <p align="center">
  2 |   <a href="" rel="noopener">
  3 |  <img width=200px height=200px src="https://i.imgur.com/6wj0hh6.jpg" alt="Project logo"></a>
  4 | </p>
  5 | 
  6 | <h3 align = "center"> Título del proyecto </h3>
  7 | 
  8 | <div align="center">
  9 | 
 10 |   [![Status](https://img.shields.io/badge/status-active-success.svg)]()
 11 |   [![GitHub Issues](https://img.shields.io/github/issues/kylelobo/The-Documentation-Compendium.svg)](https://github.com/kylelobo/The-Documentation-Compendium/issues)
 12 |   [![GitHub Pull Requests](https://img.shields.io/github/issues-pr/kylelobo/The-Documentation-Compendium.svg)](https://github.com/kylelobo/The-Documentation-Compendium/pulls)
 13 |   [![License](https://img.shields.io/badge/license-MIT-blue.svg)](/LICENSE)
 14 | 
 15 | </div>
 16 | 
 17 | ---
 18 | 
 19 | <p align = "center"> Pocas líneas que describen su proyecto.
 20 |     <br>
 21 | </p>
 22 | 
 23 | ## 📝 Tabla de contenido
 24 | 
 25 | - [Acerca de](#about)
 26 | - [Introducción](#Getting_started)
 27 | - [Implementación](#implementación)
 28 | - [Uso](#uso)
 29 | - [Construido con](#built_using)
 30 | - [TODO](../TODO.md)
 31 | - [Contribuyendo](../CONTRIBUTING.md)
 32 | - [Autores](#autores)
 33 | - [Agradecimientos](#reconocimiento)
 34 | 
 35 | ## 🧐 Acerca de <a name = "about"> </a>
 36 | 
 37 | Escribe entre 1 y 2 párrafos que describan el propósito de tu proyecto.
 38 | 
 39 | ## 🏁 Comenzando <a name = "getting_started"> </a>
 40 | 
 41 | Estas instrucciones le proporcionarán una copia del proyecto en funcionamiento en su máquina local con fines de desarrollo y prueba. Consulte [implementación](#implementación) para obtener notas sobre cómo implementar el proyecto en un sistema en vivo.
 42 | 
 43 | ### Requisitos previos
 44 | 
 45 | Qué necesita para instalar el software y cómo instalarlo.
 46 | 
 47 | ```
 48 | Dar ejemplos
 49 | ```
 50 | 
 51 | ### Instalación
 52 | 
 53 | Una serie de ejemplos paso a paso que le indican cómo ejecutar un entorno de desarrollo.
 54 | 
 55 | Di cuál será el paso
 56 | 
 57 | ```
 58 | Da el ejemplo
 59 | ```
 60 | 
 61 | Y repetir
 62 | 
 63 | ```
 64 | hasta que termine
 65 | ```
 66 | 
 67 | Termine con un ejemplo de cómo sacar algunos datos del sistema o usarlos para una pequeña demostración.
 68 | 
 69 | ## 🔧 Ejecutando las pruebas <a name = "tests"> </a>
 70 | 
 71 | Explique cómo ejecutar las pruebas automatizadas para este sistema.
 72 | 
 73 | ### Desglosar en pruebas de un extremo a otro
 74 | 
 75 | Explique qué prueban estas pruebas y por qué
 76 | 
 77 | ```
 78 | Dar un ejemplo
 79 | ```
 80 | 
 81 | ### Y pruebas de estilo de codificación
 82 | 
 83 | Explique qué prueban estas pruebas y por qué
 84 | 
 85 | ```
 86 | Dar un ejemplo
 87 | ```
 88 | 
 89 | ## 🎈 Uso <a name="usage"> </a>
 90 | 
 91 | Agregue notas sobre cómo usar el sistema.
 92 | 
 93 | ## 🚀 Implementación <a name = "deployment"> </a>
 94 | 
 95 | Agregue notas adicionales sobre cómo implementar esto en un sistema en vivo.
 96 | 
 97 | ## ⛏️ Creado con <a name = "built_using"> </a>
 98 | 
 99 | - [MongoDB](https://www.mongodb.com/) - Base de datos
100 | - [Express](https://expressjs.com/) - Marco del servidor
101 | - [VueJs](https://vuejs.org/) - Marco web
102 | - [NodeJs](https://nodejs.org/en/) - Entorno del servidor
103 | 
104 | ## ✍️ Autores <a name = "authors"> </a>
105 | 
106 | - [@kylelobo](https://github.com/kylelobo) - Idea y trabajo inicial
107 | - [@FanchiniRudolf](https://github.com/FanchiniRudolf) - Traducción al español
108 | 
109 | Consulte también la lista de [contribuyentes](https://github.com/kylelobo/The-Documentation-Compendium/contributors) que participaron en este proyecto.
110 | 
111 | ## 🎉 Agradecimientos <a name = "acknowledgement"> </a>
112 | 
113 | - Apreciación para cualquier persona cuyo código se haya utilizado
114 | - inspiración
115 | - referencias
116 | 


--------------------------------------------------------------------------------
/es/TODO.md:
--------------------------------------------------------------------------------
1 | ### TODO
2 | 
3 | ---
4 | 
5 | - [x] Documentar el archivo README.md en el folder de [README_TEMPLATES](./README_TEMPLATES).
6 | - [ ] Hacer una plantilla de IoT (Usar como referencia la de documentación de los varios proyectos de Arduino). Esta plantilla debe de ser detallada e ir a profundidad a la terminologia de hardware.
7 | - [ ] Hacer una plantilla minimalista de IOT.
8 | - [ ] Añadir archivo COMMIT_MESSAGE_GUIDELINES.md.
9 | - [ ] Traducir las plantillas de [plantillas](https://github.com/kylelobo/The-Documentation-Compendium#templates) a los idiomas de - chino, francés, alemán, hindi, italiano, japonés, coreano, portugués, ruso, español, etc.


--------------------------------------------------------------------------------
/fr/CHANGELOG.md:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/race2infinity/The-Documentation-Compendium/272376ad2dfb2907b083990b3ef6a16af514ec48/fr/CHANGELOG.md


--------------------------------------------------------------------------------
/fr/CODEBASE_STRUCTURE.md:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/race2infinity/The-Documentation-Compendium/272376ad2dfb2907b083990b3ef6a16af514ec48/fr/CODEBASE_STRUCTURE.md


--------------------------------------------------------------------------------
/fr/CODE_OF_CONDUCT.md:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/race2infinity/The-Documentation-Compendium/272376ad2dfb2907b083990b3ef6a16af514ec48/fr/CODE_OF_CONDUCT.md


--------------------------------------------------------------------------------
/fr/CODING_GUIDELINES.md:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/race2infinity/The-Documentation-Compendium/272376ad2dfb2907b083990b3ef6a16af514ec48/fr/CODING_GUIDELINES.md


--------------------------------------------------------------------------------
/fr/CONTRIBUTING.md:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/race2infinity/The-Documentation-Compendium/272376ad2dfb2907b083990b3ef6a16af514ec48/fr/CONTRIBUTING.md


--------------------------------------------------------------------------------
/fr/ISSUE_TEMPLATES/bug_report.md:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/race2infinity/The-Documentation-Compendium/272376ad2dfb2907b083990b3ef6a16af514ec48/fr/ISSUE_TEMPLATES/bug_report.md


--------------------------------------------------------------------------------
/fr/ISSUE_TEMPLATES/custom.md:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/race2infinity/The-Documentation-Compendium/272376ad2dfb2907b083990b3ef6a16af514ec48/fr/ISSUE_TEMPLATES/custom.md


--------------------------------------------------------------------------------
/fr/ISSUE_TEMPLATES/feature_request.md:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/race2infinity/The-Documentation-Compendium/272376ad2dfb2907b083990b3ef6a16af514ec48/fr/ISSUE_TEMPLATES/feature_request.md


--------------------------------------------------------------------------------
/fr/PULL_REQUEST_TEMPLATE.md:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/race2infinity/The-Documentation-Compendium/272376ad2dfb2907b083990b3ef6a16af514ec48/fr/PULL_REQUEST_TEMPLATE.md


--------------------------------------------------------------------------------
/fr/README_TEMPLATES/Bot.md:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/race2infinity/The-Documentation-Compendium/272376ad2dfb2907b083990b3ef6a16af514ec48/fr/README_TEMPLATES/Bot.md


--------------------------------------------------------------------------------
/fr/README_TEMPLATES/Hackathon.md:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/race2infinity/The-Documentation-Compendium/272376ad2dfb2907b083990b3ef6a16af514ec48/fr/README_TEMPLATES/Hackathon.md


--------------------------------------------------------------------------------
/fr/README_TEMPLATES/IoT.md:
--------------------------------------------------------------------------------
1 | TODO
2 | 


--------------------------------------------------------------------------------
/fr/README_TEMPLATES/Minimal.md:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/race2infinity/The-Documentation-Compendium/272376ad2dfb2907b083990b3ef6a16af514ec48/fr/README_TEMPLATES/Minimal.md


--------------------------------------------------------------------------------
/fr/README_TEMPLATES/README.md:
--------------------------------------------------------------------------------
1 | ### This folder contains various README Templates that one can use based on the type of project.
2 | 
3 | 1. [Bot.md](/README%20Templates/Bot.md) - 
4 | 2. [Hackathon.md](/README%20Templates/Hackathon.md) - 
5 | 3. [IoT.md](/README%20Templates/IoT.md) - 
6 | 4. [Minimal.md](/README%20Templates/Minimal.md) - 
7 | 5. [Standard.md](/README%20Templates/Standard.md) - 
8 | 


--------------------------------------------------------------------------------
/fr/README_TEMPLATES/Standard.md:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/race2infinity/The-Documentation-Compendium/272376ad2dfb2907b083990b3ef6a16af514ec48/fr/README_TEMPLATES/Standard.md


--------------------------------------------------------------------------------
/fr/TODO.md:
--------------------------------------------------------------------------------
1 | ### TODO
2 | 
3 | ---
4 | 
5 | - [ ] переводить шаблоны
6 | 
7 | 


--------------------------------------------------------------------------------
/hi/CHANGELOG.md:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/race2infinity/The-Documentation-Compendium/272376ad2dfb2907b083990b3ef6a16af514ec48/hi/CHANGELOG.md


--------------------------------------------------------------------------------
/hi/CODEBASE_STRUCTURE.md:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/race2infinity/The-Documentation-Compendium/272376ad2dfb2907b083990b3ef6a16af514ec48/hi/CODEBASE_STRUCTURE.md


--------------------------------------------------------------------------------
/hi/CODE_OF_CONDUCT.md:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/race2infinity/The-Documentation-Compendium/272376ad2dfb2907b083990b3ef6a16af514ec48/hi/CODE_OF_CONDUCT.md


--------------------------------------------------------------------------------
/hi/CODING_GUIDELINES.md:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/race2infinity/The-Documentation-Compendium/272376ad2dfb2907b083990b3ef6a16af514ec48/hi/CODING_GUIDELINES.md


--------------------------------------------------------------------------------
/hi/CONTRIBUTING.md:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/race2infinity/The-Documentation-Compendium/272376ad2dfb2907b083990b3ef6a16af514ec48/hi/CONTRIBUTING.md


--------------------------------------------------------------------------------
/hi/ISSUE_TEMPLATES/bug_report.md:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/race2infinity/The-Documentation-Compendium/272376ad2dfb2907b083990b3ef6a16af514ec48/hi/ISSUE_TEMPLATES/bug_report.md


--------------------------------------------------------------------------------
/hi/ISSUE_TEMPLATES/custom.md:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/race2infinity/The-Documentation-Compendium/272376ad2dfb2907b083990b3ef6a16af514ec48/hi/ISSUE_TEMPLATES/custom.md


--------------------------------------------------------------------------------
/hi/ISSUE_TEMPLATES/feature_request.md:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/race2infinity/The-Documentation-Compendium/272376ad2dfb2907b083990b3ef6a16af514ec48/hi/ISSUE_TEMPLATES/feature_request.md


--------------------------------------------------------------------------------
/hi/PULL_REQUEST_TEMPLATE.md:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/race2infinity/The-Documentation-Compendium/272376ad2dfb2907b083990b3ef6a16af514ec48/hi/PULL_REQUEST_TEMPLATE.md


--------------------------------------------------------------------------------
/hi/README_TEMPLATES/Bot.md:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/race2infinity/The-Documentation-Compendium/272376ad2dfb2907b083990b3ef6a16af514ec48/hi/README_TEMPLATES/Bot.md


--------------------------------------------------------------------------------
/hi/README_TEMPLATES/Hackathon.md:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/race2infinity/The-Documentation-Compendium/272376ad2dfb2907b083990b3ef6a16af514ec48/hi/README_TEMPLATES/Hackathon.md


--------------------------------------------------------------------------------
/hi/README_TEMPLATES/IoT.md:
--------------------------------------------------------------------------------
1 | TODO
2 | 


--------------------------------------------------------------------------------
/hi/README_TEMPLATES/Minimal.md:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/race2infinity/The-Documentation-Compendium/272376ad2dfb2907b083990b3ef6a16af514ec48/hi/README_TEMPLATES/Minimal.md


--------------------------------------------------------------------------------
/hi/README_TEMPLATES/README.md:
--------------------------------------------------------------------------------
1 | ### This folder contains various README Templates that one can use based on the type of project.
2 | 
3 | 1. [Bot.md](/README%20Templates/Bot.md) - 
4 | 2. [Hackathon.md](/README%20Templates/Hackathon.md) - 
5 | 3. [IoT.md](/README%20Templates/IoT.md) - 
6 | 4. [Minimal.md](/README%20Templates/Minimal.md) - 
7 | 5. [Standard.md](/README%20Templates/Standard.md) - 
8 | 


--------------------------------------------------------------------------------
/hi/README_TEMPLATES/Standard.md:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/race2infinity/The-Documentation-Compendium/272376ad2dfb2907b083990b3ef6a16af514ec48/hi/README_TEMPLATES/Standard.md


--------------------------------------------------------------------------------
/hi/TODO.md:
--------------------------------------------------------------------------------
1 | ### TODO
2 | 
3 | ---
4 | 
5 | - [ ] переводить шаблоны
6 | 
7 | 


--------------------------------------------------------------------------------
/it/CHANGELOG.md:
--------------------------------------------------------------------------------
 1 | # Log delle Modifiche
 2 | 
 3 | Tutte le modifiche notevoli saranno documentate su questo file.
 4 | 
 5 | Questo format è basato su [Keep a Changelog](http://keepachangelog.com/) e questo progetto aderisce a [Semantic Versioning](http://semver.org/).
 6 | 
 7 | ## [Non Rilasciato] - yyyy-mm-dd
 8 | 
 9 | Qua scriviamo note per le aziende per aggiornare. È uno sforzo di gruppo renderle il più semplice possibile.
10 | 
11 | ### Aggiunto
12 | 
13 | - [NOMEPROGETTO-XXXX](http://tickets.projectname.com/browse/PROJECTNAME-XXXX)
14 |   MINOR Titolo ticket va qua.
15 | - [NOMEPROGETTO-YYYY](http://tickets.projectname.com/browse/PROJECTNAME-YYYY)
16 |   PATCH Titolo ticket va qua.
17 | 
18 | ### Cambiato
19 | 
20 | ### Sistemato
21 | 
22 | ## [1.2.4] - 2017-03-15
23 | 
24 | Qua avremmo le istruzioni per gli utenti da seguire per aggiornare a 1.2.4.
25 | 
26 | ### Aggiunto
27 | 
28 | ### Cambiato
29 | 
30 | - [NOMEPROGETTO-ZZZZ](http://tickets.projectname.com/browse/PROJECTNAME-ZZZZ)
31 |   PATCH Drupal.org è ora usato come composer.
32 | 
33 | ### Sistemato
34 | 
35 | - [NOMEPROGETTO-TTTT](http://tickets.projectname.com/browse/PROJECTNAME-TTTT)
36 |   PATCH Aggiunta logica a runsheet teaser delete per cancellare corrispondenti schedule cards.
37 | 
38 | ## [1.2.3] - 2017-03-14
39 | 
40 | ### Aggiunto
41 | 
42 | ### Cambiato
43 | 
44 | ### Sistemato
45 | 
46 | - [PROJECTNAME-UUUU](http://tickets.projectname.com/browse/PROJECTNAME-UUUU)
47 |   MINOR Sistemati i test per il modulo foo
48 | - [PROJECTNAME-RRRR](http://tickets.projectname.com/browse/PROJECTNAME-RRRR)
49 |   MAJOR La timeline del modulo foo usa il fuso orario del browser per la risoluzione della data
50 | 


--------------------------------------------------------------------------------
/it/CODEBASE_STRUCTURE.md:
--------------------------------------------------------------------------------
 1 | Queste sono le cartelle che stiamo usando attivamente nello sviluppo:
 2 | 
 3 | - [frontend/server/controllers](https://github.com/kylelobo/The-Documentation-Compendium/tree/master/frontend/server/controllers): I controller che si occupano della logica ed espongono l'API del server.
 4 | - [frontend/server/libs](https://github.com/The-Documentation-Compendium/tree/master/frontend/server/libs): Librerie e servizi.
 5 | - [frontend/server/libs/dao](https://github.com/The-Documentation-Compendium/tree/master/frontend/server/libs/dao): Data Access Objects [DAO] e Value Objects [VO]. Classi usate per rappresentare schemi di database e facilitarne l'utilizzo per i controller.
 6 | - [frontend/templates](https://github.com/The-Documentation-Compendium/tree/master/frontend/templates): Template intelligenti usati per generare l'HTML che viene visualizzato dagli utenti.
 7 | - [frontend/www](https://github.com/The-Documentation-Compendium/tree/master/frontend/www): I contenuti completi della pagina Internet.
 8 | 
 9 | ### frontend / www
10 | 
11 | Contenuto:
12 | 
13 | - js /
14 | - css /
15 | 
16 | #### js
17 | 
18 | Come implica il nome, questa cartella è dove risiedono tutti i font javascript e i framework javascript. Quando vuoi apportare modifiche, per favore, minimizza il codice javascript e poi carica.
19 | 
20 | #### css
21 | 
22 | Analogo a js, contiene i file css minimizzati.
23 | 
24 | ### frontend / server
25 | 
26 | Contenuto:
27 | 
28 | - dao /
29 | - controllers /
30 | 
31 | Nessuno di questi moduli dovrebbe essere accessibile al mondo esterno. L'unico che può chiamarli è l'interfaccia utente. Questo è il motivo per cui sono dentro alla cartella www.
32 | 
33 | #### DAO / VO
34 | 
35 | La cartella _dao_ contiene le classi per il livello di accesso ai dati. Ha 2 cose da sapere: _data access objects_ e _value objects_. I _value objects_ (VO) sono niente più che classi mappate direttamente a ciascuna delle tabelle nel database. Perciò, esiste una classe lì dentro chiamata Users, siccome c'è una tabella con lo stesso nome. Questa classe ha i suoi setter e getter per ogni campo nel database. I _data access objects_ (dao) sono classi statiche per ogni tabella, e servono ad ottenere e rendere gli oggetti _vo_ persistenti.
36 | 
37 | [Qua ci sono più informazioni su questo modello](http://www.ibm.com/developerworks/java/library/j-dao/)
38 | 
39 | #### Controller
40 | 
41 | I controller sono dove le decisioni sono fatte. Il controller usa i dao's e vo's per fare decisioni, e mai chiamare il database direttamente. In questo modo, si evita di avere controller separati per ogni modulo del progetto.
42 | 


--------------------------------------------------------------------------------
/it/CODE_OF_CONDUCT.md:
--------------------------------------------------------------------------------
 1 | # Codice di Comportamento del Collaboratore
 2 | 
 3 | ## Il Nostro Impegno
 4 | 
 5 | Nell'interesse della promozione di un ambiente aperto e accogliente, noi
 6 | contributori e manutentori ci impegnamo a rendere la partecipazione alla nostra
 7 | comunità un'esperienza libera da molestie per tutti, indipendentemente dall'età,
 8 | corporatura, disabilità visibile o meno, etnia,
 9 | caratteristiche sessuali, identità ed espressione di genere, livello di
10 | esperienza, istruzione, stato socio-economico, nazionalità, aspetto, razza,
11 | religione o identità e orientamento sessuale.
12 | 
13 | Noi ci impegniamo ad agire ed interagire per costruire una comunità aperta,
14 | accogliente, diversificata, inclusiva e sana.
15 | 
16 | ## I nostri Standard
17 | 
18 | Esempi di comportamenti che contribuiscono alla creazione di un ambiente
19 | positivo per la nostra comunità:
20 | 
21 | - Dimostrare empatia e gentilezza verso le altre persone
22 | - Rispettare le opinioni, i punti di vista ed esperienze differenti
23 | - Fornire, con garbo, critiche costruttive
24 | - Prendersi la responsabilità di quanto sostenuto e scusarsi verso le persone
25 |   colpite dai nostri sbagli, imparando da queste esperienze
26 | - Concentrarsi non su ciò che è meglio per noi come individui, ma su ciò
27 |   che è meglio per la comunità
28 | 
29 | Esempi di comportamento inaccettabile:
30 | 
31 | - L'uso di linguaggio o immagini sessualizzate e l'attenzione sessuale o
32 |   avance indesiderate
33 | - Comportamenti da troll, commenti offensivi e attacchi personali o politici
34 | - Molestie in pubblico o in privato
35 | - Pubblicazione di informazioni private altrui, ad esempio un indirizzo postale o
36 |   elettronico, senza autorizzazione esplicita
37 | - Altri comportamenti che potrebbero ragionevolmente essere considerati
38 |   inappropriati in un contesto professionale
39 | 
40 | ## Adempimento e Responsabilità
41 | 
42 | Le persone alla guida della comunità sono responsabili del chiarimento e
43 | dell'applicazione degli standard di comportamento accettabili e sono tenuti a
44 | intraprendere azioni correttive appropriate ed eque in risposta a qualsiasi
45 | caso di comportamento inaccettabile, minaccioso, offensivo o dannoso.
46 | 
47 | Le persone alla guida della comunità hanno il diritto e la responsabilità di
48 | rimuovere, modificare o rifiutare commenti, commit, codice, modifiche dei wiki,
49 | issue e altri contributi non allineati a questo Codice di Comportamento, comunicando
50 | le ragioni dell'intervento di moderazione quando opportuno.
51 | 
52 | ## Scopo
53 | 
54 | Questo Codice di Comportamento si applica sia all'interno degli spazi della comunità
55 | che negli spazi pubblici quando un individuo rappresenta la sua comunità.
56 | Esempi di rappresentanza della nostra comunità includono l'uso di un indirizzo e-mail
57 | ufficiale del progetto, la pubblicazione tramite un account ufficiale attraverso
58 | social media o la funzione di rappresentante designato ad un evento online o offline.
59 | 
60 | ## Applicazione
61 | 
62 | I casi di comportamento abusivo, molesto o altrimenti inaccettabile possono
63 | essere presentate contattando i responsabili dell'applicazione di questo Codice di Condotta della comunità all'indirizzo [INSERISCI INDIRIZZO EMAIL].
64 | Tutti i reclami saranno prontamente esaminati ed indagati.
65 | 
66 | Tutte le guide della comunità sono obbligate a mantenere la riservatezza della persona che ha riportato il caso.
67 | 
68 | ## Attribuzione
69 | 
70 | Questo Codice di Comportamento è adattato dal [Contributor Covenant][homepage], versione 2.0,
71 | disponibile all'indirizzo https://www.contributor-covenant.org/version/2/0/code-of-conduct.html
72 | 
73 | [homepage]: https://www.contributor-covenant.org
74 | 
75 | Per riposte a domande comuni riguardo questo codice di condotta,
76 | controlla le domande frequenti al link https://www.contributor-covenant.org/faq.
77 | 


--------------------------------------------------------------------------------
/it/CODING_GUIDELINES.md:
--------------------------------------------------------------------------------
 1 | # Linee Guida di Programmazione
 2 | 
 3 | - Puoi validare che il tuo codice segua queste linee guida eseguendo `stuff/php-format.py validate`
 4 | - Tab, non spazi
 5 | - Il fine riga dovrebbe essere stile Unix (`\n`), non stile Windows (`\r\n`)
 6 | - Le parentesi aperte vanno sulla stessa riga dell'ultima istruzione
 7 | 
 8 | ```
 9 |     if (condition) {
10 |         stuff;
11 |     }
12 | ```
13 | 
14 | - Uno spazio tra parole chiave e parentesi per: `if`, `else`, `while`, `switch`, `catch`, `function`
15 | - Chiamate di funzioni non hanno uno spazio prima delle parentesi
16 | - Non ci sono spazi sulla sinistra dentro alle parentesi
17 | - Uno spazio dopo ogni virgola, ma senza spazio prima
18 | - Tutti gli operatori binari devono avere uno spazio prima e uno dopo
19 | - Non dovrebbero esserci più di una linea vuota contigua
20 | - Non dovrebbero esserci commenti vuoti
21 | - Non dovresti usare commenti di blocco `/ * ... * /`, solo di linea `// ...`
22 | - Modifiche alla funzionalità devono essere accompagnate da rispettivi test nuovi o modificati
23 | - Eccezioni vanno usate per segnalare stati erronei. L'uso di funzioni che ritornano true / false è permesso quando sono i valori aspettati
24 | - Usa [RAII] (http://en.wikipedia.org/wiki/Resource_Acquisition_Is_Initialization) quando adeguato, principalmente nell'amministrazione di risorse (file, etc ...)
25 | 


--------------------------------------------------------------------------------
/it/CONTRIBUTING.md:
--------------------------------------------------------------------------------
 1 | # Guida alla Contribuzione
 2 | 
 3 | - Contribuire a The Documentation Compendium è relativamente facile. Questo documento ti illustra come iniziare
 4 | 
 5 | ## In Generale
 6 | 
 7 | - La [Struttura della Codebase](./CODEBASE_STRUCTURE.md) haa informazioni dettagliate su come i vari file in questo progetto sono strutturati
 8 | - Per favore assicurati che ogni modifica che fai sia in accordanza con le [Linee Guida di Programmazione](./CODING_GUIDELINES.md) di questa repository.
 9 | 
10 | ## Sottomettere Cambiamenti
11 | 
12 | - Forka la repo
13 |   - <https://github.com/kylelobo/The-Documentation-Compendium/fork>
14 | - Crea una nuova branch e dalle un nome inerente a quello che vuoi fare:
15 |   - Esempio:
16 |     ```
17 |     $ git checkout -b NOME_BRANCH
18 |     ```
19 |     Se riscontri un errore, potresti aver bisogno di fetchare fooBar con
20 |     ```
21 |     $ git remote update && git fetch
22 |     ```
23 |   - Usa una branch per fix / feature
24 | - Committa le tue modifiche
25 |   - Per favore fornisci un messaggio git che spiega cosa hai fatto
26 |   - Per favore assicurati che i tuoi commit seguano le [convenzioni](https://gist.github.com/robertpainsi/b632364184e70900af4ab688decf6f53#file-commit-message-guidelines-md)
27 |   - Committa sulla repo forkata
28 |   - Esempio:
29 |     ```
30 |     $ git commit -am 'Aggiunto fooBar'
31 |     ```
32 | - Pusha sulla branch
33 |   - Esempio:
34 |     ```
35 |     $ git push origin NOME_BRANCH
36 |     ```
37 | - Fai una pull request
38 |   - Assicurati di mandare la PR alla branch <code>fooBar</code>
39 |   - Travis CI is watching you!
40 | 
41 | Se segui queste istruzioni, la tua PR arriverà tranquillamente nella repo principale!
42 | 


--------------------------------------------------------------------------------
/it/ISSUE_TEMPLATES/bug_report.md:
--------------------------------------------------------------------------------
 1 | ---
 2 | name: Segnalazione bug
 3 | about: Crea una segnalazione per aiutarci
 4 | title: ""
 5 | labels: ""
 6 | assignees: ""
 7 | ---
 8 | 
 9 | **Descrivi il bug**
10 | Una descrizione chiara e concisa del bug.
11 | 
12 | **Per riprodurre**
13 | Passi per riprodurre il comportamento:
14 | 
15 | 1. Vai a '...'
16 | 2. Clicca su '....'
17 | 3. Scendi fino a '....'
18 | 4. Vedi errore
19 | 
20 | **Comportamento atteso**
21 | Una chiara e concisa descrizione di cosa ti aspettavi succedesse.
22 | 
23 | **Screenshot**
24 | Se applicabile, aggiungi screenshot per aiutare a spiegare il tuo problema.
25 | 
26 | **Desktop (per favore completa le seguenti informazioni):**
27 | 
28 | - OS: [e.g. iOS]
29 | - Browser [e.g. chrome, safari]
30 | - Versione [e.g. 22]
31 | 
32 | **Smartphone (per favore completa le seguenti informazioni):**
33 | 
34 | - Dispositivo: [e.g. iPhone6]
35 | - OS: [e.g. iOS8.1]
36 | - Browser [e.g. browser predefinito, safari]
37 | - Versione [e.g. 22]
38 | 
39 | **Ulteriore contesto**
40 | Aggiungi qui qualsiasi altro contesto riguardo al problema.
41 | 


--------------------------------------------------------------------------------
/it/ISSUE_TEMPLATES/custom.md:
--------------------------------------------------------------------------------
1 | ---
2 | name: Modello issue personalizzato
3 | about: Descrivi qui il motivo di questo modello di issue.
4 | title: ""
5 | labels: ""
6 | assignees: ""
7 | ---
8 | 


--------------------------------------------------------------------------------
/it/ISSUE_TEMPLATES/feature_request.md:
--------------------------------------------------------------------------------
 1 | ---
 2 | name: Domanda di funzionalità
 3 | about: Suggerisci un'idea per questo progetto
 4 | title: ""
 5 | labels: ""
 6 | assignees: ""
 7 | ---
 8 | 
 9 | **La tua richiesta di funzionalità è legata ad un problema? Per favore descrivi.**
10 | Una spiegazione chiara e concisa di quale sia il problema. Ex. Sono sempre infastidito quando [...]
11 | 
12 | **Descrivi una soluzione che ti piacerebbe**
13 | Una spiegazione chiara e concisa di cosa vorresti che succedesse.
14 | 
15 | **Descrivi alternative che hai considerato**
16 | Una chiara e concisa descrizione di altre soluzioni alternative o funzionalità che hai considerato.
17 | 
18 | **Ulteriore contesto**
19 | Aggiungi altro contesto o screenshot riguardo alla domanda di funzionalità qui.
20 | 


--------------------------------------------------------------------------------
/it/PULL_REQUEST_TEMPLATE.md:
--------------------------------------------------------------------------------
 1 | ### La tua lista di controllo per questa pull request
 2 | 
 3 | 🚨 Per favore consulta le [linee guida per la contribuzione](./CONTRIBUTING.md) per questa repository.
 4 | 
 5 | - [ ] Assicurati di star richiedendo di **pullare una branch topic/feature/bugfix** (lato destro). Non richiedere il master!
 6 | - [ ] Assicurati che la tua pull request sia contro la **branch fooBar** (lato sinistro).
 7 | - [ ] Controlla che i messaggi dei tuoi commit siano uniformi con la nostra struttura richiesta.
 8 | - [ ] Controlla che le tue aggiunte di codice non falliscano i test di linting né gli unit test.
 9 | 
10 | ### Descrizione
11 | 
12 | Per favore descrivi la tua pull request.
13 | 
14 | ❤️ Grazie!
15 | 


--------------------------------------------------------------------------------
/it/README_TEMPLATES/Bot.md:
--------------------------------------------------------------------------------
  1 | <p align="center">
  2 |   <a href="" rel="noopener">
  3 |  <img width=200px height=200px src="https://i.imgur.com/FxL5qM0.jpg" alt="Bot logo"></a>
  4 | </p>
  5 | 
  6 | <h3 align="center">Nome del Bot</h3>
  7 | 
  8 | <div align="center">
  9 | 
 10 | [![Status](https://img.shields.io/badge/status-active-success.svg)]()
 11 | [![Platform](https://img.shields.io/badge/platform-reddit-orange.svg)](https://www.reddit.com/user/Wordbook_Bot)
 12 | [![GitHub Issues](https://img.shields.io/github/issues/kylelobo/The-Documentation-Compendium.svg)](https://github.com/kylelobo/The-Documentation-Compendium/issues)
 13 | [![GitHub Pull Requests](https://img.shields.io/github/issues-pr/kylelobo/The-Documentation-Compendium.svg)](https://github.com/kylelobo/The-Documentation-Compendium/pulls)
 14 | [![License](https://img.shields.io/badge/license-MIT-blue.svg)](/LICENSE)
 15 | 
 16 | </div>
 17 | 
 18 | ---
 19 | 
 20 | <p align="center"> 🤖 Qualche riga per descrivere le funzionalità del tuo bot.
 21 |     <br> 
 22 | </p>
 23 | 
 24 | ## 📝 Indice
 25 | 
 26 | - [Descrizione](#about)
 27 | - [Demo / Funzionamento](#demo)
 28 | - [Come Funziona](#working)
 29 | - [Utilizzo](#usage)
 30 | - [Come Iniziare](#getting_started)
 31 | - [Deployare il tuo bot](#deployment)
 32 | - [Costruito Con](#built_using)
 33 | - [TODO](../TODO.md)
 34 | - [Contribuire](../CONTRIBUTING.md)
 35 | - [Autori](#authors)
 36 | - [Riconoscimenti](#acknowledgement)
 37 | 
 38 | ## 🧐 Descrizione <a name = "about"></a>
 39 | 
 40 | Scrivi circa 1-2 paragrafi descrivendo lo scopo del tuo bot.
 41 | 
 42 | ## 🎥 Demo / Funzionamento <a name = "demo"></a>
 43 | 
 44 | ![Funzionamento](https://media.giphy.com/media/20NLMBm0BkUOwNljwv/giphy.gif)
 45 | 
 46 | ## 💭 Come Funziona <a name = "working"></a>
 47 | 
 48 | Il bot per prima cosa estrae la parola dal commento e poi ottiene le definizioni, parte del discorso, esempio e fonte dalla API di Oxford Dictionary.
 49 | 
 50 | Se la parola non esiste in Oxford Dictionary, l'API Oxford restituisce una risposta 404, per cui il bot prova ad ottenere risulati dall'API di Urban Dictionary.
 51 | 
 52 | Il bot usa Pushshift API per ottenere commenti, PRAW module per rispondere ai commenti e Heroku come server.
 53 | 
 54 | Per intero il bot è scritto in Python 3.6
 55 | 
 56 | ## 🎈 Utilizzo <a name = "usage"></a>
 57 | 
 58 | Per usare il bot, scrivi:
 59 | 
 60 | ```
 61 | !dict word
 62 | ```
 63 | 
 64 | La prima parte, i.e. "!dict" **non** tiene conto del maiuscolo o minuscolo.
 65 | 
 66 | Il bot quindi ti darò la definizione secondo Oxford Dictionary (o Urban Dictionary; se la parola non esiste in Oxford Dictionary) come risposta.
 67 | 
 68 | ### Esempio:
 69 | 
 70 | > !dict what is love
 71 | 
 72 | **Definition:**
 73 | 
 74 | Baby, dont hurt me~
 75 | Dont hurt me~ no more.
 76 | 
 77 | **Example:**
 78 | 
 79 | Dude1: Bruh, what is love?
 80 | Dude2: Baby, dont hurt me, dont hurt me- no more!
 81 | Dude1: dafuq?
 82 | 
 83 | **Source:** https://www.urbandictionary.com/define.php?term=what%20is%20love
 84 | 
 85 | ---
 86 | 
 87 | <sup>Beep boop. I am a bot. If there are any issues, contact my [Master](https://www.reddit.com/message/compose/?to=PositivePlayer1&subject=/u/Wordbook_Bot)</sup>
 88 | 
 89 | <sup>Want to make a similar reddit bot? Check out: [GitHub](https://github.com/kylelobo/Reddit-Bot)</sup>
 90 | 
 91 | ## 🏁 Come Iniziare <a name = "getting_started"></a>
 92 | 
 93 | Queste istruzioni ti daranno una copia del progetto funzionante sul tuo computer locale per scopi di sviluppo e testing. Vedi [deployment](#deployment) per istruzioni su come deployare il progetto.
 94 | 
 95 | ### Prerequisiti
 96 | 
 97 | Di cosa hai bisogno per installare il software e come installarle.
 98 | 
 99 | ```
100 | Dai esempi
101 | ```
102 | 
103 | ### Installazione
104 | 
105 | Una serie di esempi passo a passo che ti dicono come avviare un ambiente di sviluppo.
106 | 
107 | Indica qual è il passo
108 | 
109 | ```
110 | Dai l'esempio
111 | ```
112 | 
113 | E ripeti
114 | 
115 | ```
116 | Fino alla fine
117 | ```
118 | 
119 | Chiudi con un esempio su come ottenere dei dati dal sistema o su come usarlo per una piccola demo.
120 | 
121 | ## 🚀 Deployare il tuo bot <a name = "deployment"></a>
122 | 
123 | Per vedere un esempio di progetto su come deployare il tuo bot, vedi la mia configurazione:
124 | 
125 | - **Heroku**: https://github.com/kylelobo/Reddit-Bot#deploying_the_bot
126 | 
127 | ## ⛏️ Costruito con <a name = "tech_stack"></a>
128 | 
129 | - [PRAW](https://praw.readthedocs.io/en/latest/) - Python Reddit API Wrapper
130 | - [Heroku](https://www.heroku.com/) - SaaS hosting platform
131 | 
132 | ## ✍️ Autori <a name = "authors"></a>
133 | 
134 | - [@kylelobo](https://github.com/kylelobo) - Idea & Lavoro iniziare
135 | 
136 | Vedi anche la lista di [contributori](https://github.com/kylelobo/The-Documentation-Compendium/contributors)
137 | che hanno partecipato a questo progetto.
138 | 
139 | ## 🎉 Riconoscimenti <a name = "acknowledgments"></a>
140 | 
141 | - Cenno a tutti quelli il cui codice è stato utilizzato
142 | - Ispirazione
143 | - Riferimenti
144 | 


--------------------------------------------------------------------------------
/it/README_TEMPLATES/Hackathon.md:
--------------------------------------------------------------------------------
  1 | <p align="center">
  2 |   <a href="" rel="noopener">
  3 |  <img src="https://i.imgur.com/AZ2iWek.png" alt="Project logo"></a>
  4 | </p>
  5 | <h3 align="center">Titolo del Progetto</h3>
  6 | 
  7 | <div align="center">
  8 | 
  9 | [![Hackathon](https://img.shields.io/badge/hackathon-name-orange.svg)](http://hackathon.url.com)
 10 | [![Status](https://img.shields.io/badge/status-active-success.svg)]()
 11 | [![GitHub Issues](https://img.shields.io/github/issues/kylelobo/The-Documentation-Compendium.svg)](https://github.com/kylelobo/The-Documentation-Compendium/issues)
 12 | [![GitHub Pull Requests](https://img.shields.io/github/issues-pr/kylelobo/The-Documentation-Compendium.svg)](https://github.com/kylelobo/The-Documentation-Compendium/pulls)
 13 | [![License](https://img.shields.io/badge/license-MIT-blue.svg)](LICENSE.md)
 14 | 
 15 | </div>
 16 | 
 17 | ---
 18 | 
 19 | <p align="center"> Poche righe di descrizione del tuo progetto.
 20 |     <br> 
 21 | </p>
 22 | 
 23 | ## 📝 Indice
 24 | 
 25 | - [Testo del Problema](#problem_statement)
 26 | - [Idea / Soluzione](#idea)
 27 | - [Dipendenze / Limitazioni](#limitations)
 28 | - [Scopo Futuro](#future_scope)
 29 | - [Impostare un ambiente locale](#getting_started)
 30 | - [Utilizzo](#usage)
 31 | - [Tecnologie Utilizzate](#tech_stack)
 32 | - [Contribuire](../CONTRIBUTING.md)
 33 | - [Autori](#authors)
 34 | - [Riconoscimenti](#acknowledgments)
 35 | 
 36 | ## 🧐 Testo del Problema <a name = "problem_statement"></a>
 37 | 
 38 | È utile progettare e seguire un format specifico quando si scrive il testo di un problema. Sebbene ci siano diverse opzioni per far ciò, quanto segue è un semplice e diretto modello spesso usato in Analisi Aziendale per mantenere il focus sulla definizione del problema.
 39 | 
 40 | - IDEALE: Questa sezione è utilizzata per descrivere lo stato finale del processo o prodotto. Alla larga, questa sezione
 41 |   dovrebbe illustrare come l'ambiente si presenterà una volta implementata la soluzione.
 42 | - REALTÀ: Questa sezione serve a descrivere lo stato corrente del processo o prodotto.
 43 | - CONSEGUENZE: Questa sezione è utilizzata per descrivere le conseguenze sull'azienda se il problema non è risolto o migliorato.
 44 |   Questo include costi associati con la perdita di soldi, tempo, produttività, vantaggi competitivi, e così via.
 45 | 
 46 | Seguire questo format risulterà in un documento che può essere utilizzato per capire il problema e suscitare requisiti che porteranno ad una soluzione vincente.
 47 | 
 48 | ## 💡 Idea / Soluzione <a name = "idea"></a>
 49 | 
 50 | Questa sezione è utilizzata per descrivere potenziali soluzioni.
 51 | 
 52 | Una volta che le sezioni ideale, realtà e conseguenze sono state completate, e capite, diventa facile fornire una soluzione al problema.
 53 | 
 54 | ## ⛓️ Dipendenze / Limitazioni <a name = "limitations"></a>
 55 | 
 56 | - Quali sono le dipendenze del tuo progetto?
 57 | - Descrivi ogni limitazione in termini dettagliati ma concisi
 58 | - Spiega il motivo dell'esistenza di ogni limitazione
 59 | - Fornisci le ragioni per cui ogni limitazione non poteva essere superata con il metodo scelto.
 60 | - Valuta l'impatto di ogni limitazione in relazione ai ritrovamenti e conclusioni del tuo progetto, e se adeguato, descrivi come queste limitazioni potrebbero indicare al bisogno di ricerche ulteriori.
 61 | 
 62 | ## 🚀 Scopo Futuro <a name = "future_scope"></a>
 63 | 
 64 | Scrivi riguardo a ciò che non sei riuscito a sviluppare durante il corso della Hackathon; e riguardo a quello che il tuo progetto può ottenere in futuro.
 65 | 
 66 | ## 🏁 Come Iniziare <a name = "getting_started"></a>
 67 | 
 68 | Queste istruzioni ti daranno una copia del progetto funzionante sul tuo computer locale per scopi di sviluppo e testing. Vedi [deployment](#deployment) per istruzioni su come deployare il progetto.
 69 | 
 70 | ### Prerequisiti
 71 | 
 72 | Di cosa hai bisogno per installare il software e come installarle.
 73 | 
 74 | ```
 75 | Dai esempi
 76 | ```
 77 | 
 78 | ### Installazione
 79 | 
 80 | Una serie di esempi passo a passo che ti dicono come avviare un ambiente di sviluppo.
 81 | 
 82 | Indica qual è il passo
 83 | 
 84 | ```
 85 | Dai l'esempio
 86 | ```
 87 | 
 88 | E ripeti
 89 | 
 90 | ```
 91 | Fino alla fine
 92 | ```
 93 | 
 94 | ## 🎈 Utilizzo <a name="usage"></a>
 95 | 
 96 | Aggiungi note su come usare il sistema.
 97 | 
 98 | ## ⛏️ Costruito con <a name = "tech_stack"></a>
 99 | 
100 | - [MongoDB](https://www.mongodb.com/) - Database
101 | - [Express](https://expressjs.com/) - Server Framework
102 | - [VueJs](https://vuejs.org/) - Web Framework
103 | - [NodeJs](https://nodejs.org/en/) - Server Environment
104 | 
105 | ## ✍️ Autori <a name = "authors"></a>
106 | 
107 | - [@kylelobo](https://github.com/kylelobo) - Idea & Lavoro iniziare
108 | 
109 | Vedi anche la lista di [contributori](https://github.com/kylelobo/The-Documentation-Compendium/contributors)
110 | che hanno partecipato a questo progetto.
111 | 
112 | ## 🎉 Riconoscimenti <a name = "acknowledgments"></a>
113 | 
114 | - Cenno a tutti quelli il cui codice è stato utilizzato
115 | - Ispirazione
116 | - Riferimenti
117 | 


--------------------------------------------------------------------------------
/it/README_TEMPLATES/IoT.md:
--------------------------------------------------------------------------------
1 | TODO
2 | 


--------------------------------------------------------------------------------
/it/README_TEMPLATES/Minimal.md:
--------------------------------------------------------------------------------
 1 | # Titolo del Progetto
 2 | 
 3 | ## Indice
 4 | 
 5 | - [Descrizione](#about)
 6 | - [Come Iniziare](#getting_started)
 7 | - [Utilizzo](#usage)
 8 | - [Contribuire](../CONTRIBUTING.md)
 9 | 
10 | ## Descrizione <a name = "about"></a>
11 | 
12 | Scrivi circa 1-2 paragrafi descrivendo lo scopo del tuo progetto.
13 | 
14 | ## Come Iniziare <a name = "getting_started"></a>
15 | 
16 | Queste istruzioni ti daranno una copia del progetto funzionante sul tuo computer locale per scopi di sviluppo e testing. Vedi [deployment](#deployment) per istruzioni su come deployare il progetto.
17 | 
18 | ### Prerequisiti
19 | 
20 | Di cosa hai bisogno per installare il software e come installarle.
21 | 
22 | ```
23 | Dai esempi
24 | ```
25 | 
26 | ### Installazione
27 | 
28 | Una serie di esempi passo a passo che ti dicono come avviare un ambiente di sviluppo.
29 | 
30 | Indica qual è il passo
31 | 
32 | ```
33 | Dai l'esempio
34 | ```
35 | 
36 | E ripeti
37 | 
38 | ```
39 | Fino alla fine
40 | ```
41 | 
42 | Chiudi con un esempio su come ottenere dei dati dal sistema o su come usarlo per una piccola demo.
43 | 
44 | ## Utilizzo <a name = "usage"></a>
45 | 
46 | Aggiungi note su come usare il sistema.
47 | 


--------------------------------------------------------------------------------
/it/README_TEMPLATES/README.md:
--------------------------------------------------------------------------------
1 | ### Questa cartella contiene vari modelli di README che si possono usare in base al tipo di progetto.
2 | 
3 | 1. [Minimal.md](/README%20Templates/Minimal.md) - Imposta velocemente un README molto basico e minimale per il tuo progetto.
4 | 2. [Standard.md](/README%20Templates/Standard.md) - Un template dettagliato e completo che copre tutti i principali aspetti di un README.
5 | 3. [Hackathon.md](/README%20Templates/Hackathon.md) - Sei ad una Hackathon e hai bisogno di impostare velocemente un README bello e approfondito che lascia un'impressione duratura sui giudici? Questo è il template per te!
6 | 4. [Bot.md](/README%20Templates/Bot.md) - Se hai creato un fantastico Bot che vuoi condividere con altri.
7 | 5. [IoT.md](/README%20Templates/IoT.md) - Questa repo illustra nel dettaglio tutti i dettagli pratici che ci sono nel documentare un progetto IoT.
8 | 


--------------------------------------------------------------------------------
/it/README_TEMPLATES/Standard.md:
--------------------------------------------------------------------------------
  1 | <p align="center">
  2 |   <a href="" rel="noopener">
  3 |  <img width=200px height=200px src="https://i.imgur.com/6wj0hh6.jpg" alt="Project logo"></a>
  4 | </p>
  5 | 
  6 | <h3 align="center">Titolo del Progetto</h3>
  7 | 
  8 | <div align="center">
  9 | 
 10 | [![Status](https://img.shields.io/badge/status-active-success.svg)]()
 11 | [![GitHub Issues](https://img.shields.io/github/issues/kylelobo/The-Documentation-Compendium.svg)](https://github.com/kylelobo/The-Documentation-Compendium/issues)
 12 | [![GitHub Pull Requests](https://img.shields.io/github/issues-pr/kylelobo/The-Documentation-Compendium.svg)](https://github.com/kylelobo/The-Documentation-Compendium/pulls)
 13 | [![License](https://img.shields.io/badge/license-MIT-blue.svg)](/LICENSE)
 14 | 
 15 | </div>
 16 | 
 17 | ---
 18 | 
 19 | <p align="center"> Poche righe di descrizione del tuo progetto.
 20 |     <br> 
 21 | </p>
 22 | 
 23 | ## 📝 Indice
 24 | 
 25 | - [Descrizione](#about)
 26 | - [Come Iniziare](#getting_started)
 27 | - [Distribuzione](#deployment)
 28 | - [Utilizzo](#usage)
 29 | - [Costruito Con](#built_using)
 30 | - [TODO](../TODO.md)
 31 | - [Contribuire](../CONTRIBUTING.md)
 32 | - [Autori](#authors)
 33 | - [Riconoscimenti](#acknowledgement)
 34 | 
 35 | ## 🧐 Descrizione <a name = "about"></a>
 36 | 
 37 | Scrivi circa 1-2 paragrafi descrivendo lo scopo del tuo progetto.
 38 | 
 39 | ## 🏁 Come Iniziare <a name = "getting_started"></a>
 40 | 
 41 | Queste istruzioni ti daranno una copia del progetto funzionante sul tuo computer locale per scopi di sviluppo e testing. Vedi [deployment](#deployment) per istruzioni su come deployare il progetto.
 42 | 
 43 | ### Prerequisiti
 44 | 
 45 | Di cosa hai bisogno per installare il software e come installarle.
 46 | 
 47 | ```
 48 | Dai esempi
 49 | ```
 50 | 
 51 | ### Installazione
 52 | 
 53 | Una serie di esempi passo a passo che ti dicono come avviare un ambiente di sviluppo.
 54 | 
 55 | Indica qual è il passo
 56 | 
 57 | ```
 58 | Dai l'esempio
 59 | ```
 60 | 
 61 | E ripeti
 62 | 
 63 | ```
 64 | Fino alla fine
 65 | ```
 66 | 
 67 | Chiudi con un esempio su come ottenere dei dati dal sistema o su come usarlo per una piccola demo.
 68 | 
 69 | ## 🔧 Eseguire i test <a name = "tests"></a>
 70 | 
 71 | Spiega come eseguire i test automatici per questo sistema.
 72 | 
 73 | ### Scomponi in test end to end
 74 | 
 75 | Spiega cosa e perchè testano questi test
 76 | 
 77 | ```
 78 | Dai un esempio
 79 | ```
 80 | 
 81 | ### E test sullo stile del codice
 82 | 
 83 | Spiega cosa e perchè testano questi test
 84 | 
 85 | ```
 86 | Dai un esempio
 87 | ```
 88 | 
 89 | ## 🚀 Distribuzione <a name = "deployment"></a>
 90 | 
 91 | Aggiungi appunti su come deployare questo progetto su un sistema live.
 92 | 
 93 | ## 🎈 Utilizzo <a name="usage"></a>
 94 | 
 95 | Aggiungi note su come usare il sistema.
 96 | 
 97 | ## ⛏️ Costruito con <a name = "tech_stack"></a>
 98 | 
 99 | - [MongoDB](https://www.mongodb.com/) - Database
100 | - [Express](https://expressjs.com/) - Server Framework
101 | - [VueJs](https://vuejs.org/) - Web Framework
102 | - [NodeJs](https://nodejs.org/en/) - Server Environment
103 | 
104 | ## ✍️ Autori <a name = "authors"></a>
105 | 
106 | - [@kylelobo](https://github.com/kylelobo) - Idea & Lavoro iniziare
107 | 
108 | Vedi anche la lista di [contributori](https://github.com/kylelobo/The-Documentation-Compendium/contributors)
109 | che hanno partecipato a questo progetto.
110 | 
111 | ## 🎉 Riconoscimenti <a name = "acknowledgments"></a>
112 | 
113 | - Cenno a tutti quelli il cui codice è stato utilizzato
114 | - Ispirazione
115 | - Riferimenti
116 | 


--------------------------------------------------------------------------------
/it/TODO.md:
--------------------------------------------------------------------------------
 1 | ### TODO
 2 | 
 3 | ---
 4 | 
 5 | - [x] Documentare il file README.md nella cartella [README_TEMPLATES](./README_TEMPLATES).
 6 | - [ ] Fare un template IoT (Riferirsi alle varie documentazioni di progetti Arduino per assistenza). Questo template deve essere dettagliato e dovrebbe entrare nel dettaglio delle varie terminologie hardware.
 7 | - [ ] Fare un template minimal IoT.
 8 | - [ ] Aggiungere un file COMMIT_MESSAGE_GUIDELINES.md.
 9 | - [ ] Tradurre i [template](https://github.com/kylelobo/The-Documentation-Compendium#templates) in lingue diverse - Cinese, Francese, Tedesco, Hindi, Giapponese, Coreano, Portoghese, Russo, Spagnolo, etc.
10 | 


--------------------------------------------------------------------------------
/jp/CHANGELOG.md:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/race2infinity/The-Documentation-Compendium/272376ad2dfb2907b083990b3ef6a16af514ec48/jp/CHANGELOG.md


--------------------------------------------------------------------------------
/jp/CODEBASE_STRUCTURE.md:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/race2infinity/The-Documentation-Compendium/272376ad2dfb2907b083990b3ef6a16af514ec48/jp/CODEBASE_STRUCTURE.md


--------------------------------------------------------------------------------
/jp/CODE_OF_CONDUCT.md:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/race2infinity/The-Documentation-Compendium/272376ad2dfb2907b083990b3ef6a16af514ec48/jp/CODE_OF_CONDUCT.md


--------------------------------------------------------------------------------
/jp/CODING_GUIDELINES.md:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/race2infinity/The-Documentation-Compendium/272376ad2dfb2907b083990b3ef6a16af514ec48/jp/CODING_GUIDELINES.md


--------------------------------------------------------------------------------
/jp/CONTRIBUTING.md:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/race2infinity/The-Documentation-Compendium/272376ad2dfb2907b083990b3ef6a16af514ec48/jp/CONTRIBUTING.md


--------------------------------------------------------------------------------
/jp/ISSUE_TEMPLATES/bug_report.md:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/race2infinity/The-Documentation-Compendium/272376ad2dfb2907b083990b3ef6a16af514ec48/jp/ISSUE_TEMPLATES/bug_report.md


--------------------------------------------------------------------------------
/jp/ISSUE_TEMPLATES/custom.md:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/race2infinity/The-Documentation-Compendium/272376ad2dfb2907b083990b3ef6a16af514ec48/jp/ISSUE_TEMPLATES/custom.md


--------------------------------------------------------------------------------
/jp/ISSUE_TEMPLATES/feature_request.md:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/race2infinity/The-Documentation-Compendium/272376ad2dfb2907b083990b3ef6a16af514ec48/jp/ISSUE_TEMPLATES/feature_request.md


--------------------------------------------------------------------------------
/jp/PULL_REQUEST_TEMPLATE.md:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/race2infinity/The-Documentation-Compendium/272376ad2dfb2907b083990b3ef6a16af514ec48/jp/PULL_REQUEST_TEMPLATE.md


--------------------------------------------------------------------------------
/jp/README_TEMPLATES/Bot.md:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/race2infinity/The-Documentation-Compendium/272376ad2dfb2907b083990b3ef6a16af514ec48/jp/README_TEMPLATES/Bot.md


--------------------------------------------------------------------------------
/jp/README_TEMPLATES/Hackathon.md:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/race2infinity/The-Documentation-Compendium/272376ad2dfb2907b083990b3ef6a16af514ec48/jp/README_TEMPLATES/Hackathon.md


--------------------------------------------------------------------------------
/jp/README_TEMPLATES/IoT.md:
--------------------------------------------------------------------------------
1 | TODO
2 | 


--------------------------------------------------------------------------------
/jp/README_TEMPLATES/Minimal.md:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/race2infinity/The-Documentation-Compendium/272376ad2dfb2907b083990b3ef6a16af514ec48/jp/README_TEMPLATES/Minimal.md


--------------------------------------------------------------------------------
/jp/README_TEMPLATES/README.md:
--------------------------------------------------------------------------------
1 | ### This folder contains various README Templates that one can use based on the type of project.
2 | 
3 | 1. [Bot.md](/README%20Templates/Bot.md) - 
4 | 2. [Hackathon.md](/README%20Templates/Hackathon.md) - 
5 | 3. [IoT.md](/README%20Templates/IoT.md) - 
6 | 4. [Minimal.md](/README%20Templates/Minimal.md) - 
7 | 5. [Standard.md](/README%20Templates/Standard.md) - 
8 | 


--------------------------------------------------------------------------------
/jp/README_TEMPLATES/Standard.md:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/race2infinity/The-Documentation-Compendium/272376ad2dfb2907b083990b3ef6a16af514ec48/jp/README_TEMPLATES/Standard.md


--------------------------------------------------------------------------------
/jp/TODO.md:
--------------------------------------------------------------------------------
1 | ### TODO
2 | 
3 | ---
4 | 
5 | - [ ] переводить шаблоны
6 | 
7 | 


--------------------------------------------------------------------------------
/ko/CHANGELOG.md:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/race2infinity/The-Documentation-Compendium/272376ad2dfb2907b083990b3ef6a16af514ec48/ko/CHANGELOG.md


--------------------------------------------------------------------------------
/ko/CODEBASE_STRUCTURE.md:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/race2infinity/The-Documentation-Compendium/272376ad2dfb2907b083990b3ef6a16af514ec48/ko/CODEBASE_STRUCTURE.md


--------------------------------------------------------------------------------
/ko/CODE_OF_CONDUCT.md:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/race2infinity/The-Documentation-Compendium/272376ad2dfb2907b083990b3ef6a16af514ec48/ko/CODE_OF_CONDUCT.md


--------------------------------------------------------------------------------
/ko/CODING_GUIDELINES.md:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/race2infinity/The-Documentation-Compendium/272376ad2dfb2907b083990b3ef6a16af514ec48/ko/CODING_GUIDELINES.md


--------------------------------------------------------------------------------
/ko/CONTRIBUTING.md:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/race2infinity/The-Documentation-Compendium/272376ad2dfb2907b083990b3ef6a16af514ec48/ko/CONTRIBUTING.md


--------------------------------------------------------------------------------
/ko/ISSUE_TEMPLATES/bug_report.md:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/race2infinity/The-Documentation-Compendium/272376ad2dfb2907b083990b3ef6a16af514ec48/ko/ISSUE_TEMPLATES/bug_report.md


--------------------------------------------------------------------------------
/ko/ISSUE_TEMPLATES/custom.md:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/race2infinity/The-Documentation-Compendium/272376ad2dfb2907b083990b3ef6a16af514ec48/ko/ISSUE_TEMPLATES/custom.md


--------------------------------------------------------------------------------
/ko/ISSUE_TEMPLATES/feature_request.md:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/race2infinity/The-Documentation-Compendium/272376ad2dfb2907b083990b3ef6a16af514ec48/ko/ISSUE_TEMPLATES/feature_request.md


--------------------------------------------------------------------------------
/ko/PULL_REQUEST_TEMPLATE.md:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/race2infinity/The-Documentation-Compendium/272376ad2dfb2907b083990b3ef6a16af514ec48/ko/PULL_REQUEST_TEMPLATE.md


--------------------------------------------------------------------------------
/ko/README_TEMPLATES/Bot.md:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/race2infinity/The-Documentation-Compendium/272376ad2dfb2907b083990b3ef6a16af514ec48/ko/README_TEMPLATES/Bot.md


--------------------------------------------------------------------------------
/ko/README_TEMPLATES/Hackathon.md:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/race2infinity/The-Documentation-Compendium/272376ad2dfb2907b083990b3ef6a16af514ec48/ko/README_TEMPLATES/Hackathon.md


--------------------------------------------------------------------------------
/ko/README_TEMPLATES/IoT.md:
--------------------------------------------------------------------------------
1 | TODO
2 | 


--------------------------------------------------------------------------------
/ko/README_TEMPLATES/Minimal.md:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/race2infinity/The-Documentation-Compendium/272376ad2dfb2907b083990b3ef6a16af514ec48/ko/README_TEMPLATES/Minimal.md


--------------------------------------------------------------------------------
/ko/README_TEMPLATES/README.md:
--------------------------------------------------------------------------------
1 | ### This folder contains various README Templates that one can use based on the type of project.
2 | 
3 | 1. [Bot.md](/README%20Templates/Bot.md) - 
4 | 2. [Hackathon.md](/README%20Templates/Hackathon.md) - 
5 | 3. [IoT.md](/README%20Templates/IoT.md) - 
6 | 4. [Minimal.md](/README%20Templates/Minimal.md) - 
7 | 5. [Standard.md](/README%20Templates/Standard.md) - 
8 | 


--------------------------------------------------------------------------------
/ko/README_TEMPLATES/Standard.md:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/race2infinity/The-Documentation-Compendium/272376ad2dfb2907b083990b3ef6a16af514ec48/ko/README_TEMPLATES/Standard.md


--------------------------------------------------------------------------------
/ko/TODO.md:
--------------------------------------------------------------------------------
1 | ### TODO
2 | 
3 | ---
4 | 
5 | - [ ] переводить шаблоны
6 | 
7 | 


--------------------------------------------------------------------------------
/pt/CHANGELOG.md:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/race2infinity/The-Documentation-Compendium/272376ad2dfb2907b083990b3ef6a16af514ec48/pt/CHANGELOG.md


--------------------------------------------------------------------------------
/pt/CODEBASE_STRUCTURE.md:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/race2infinity/The-Documentation-Compendium/272376ad2dfb2907b083990b3ef6a16af514ec48/pt/CODEBASE_STRUCTURE.md


--------------------------------------------------------------------------------
/pt/CODE_OF_CONDUCT.md:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/race2infinity/The-Documentation-Compendium/272376ad2dfb2907b083990b3ef6a16af514ec48/pt/CODE_OF_CONDUCT.md


--------------------------------------------------------------------------------
/pt/CODING_GUIDELINES.md:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/race2infinity/The-Documentation-Compendium/272376ad2dfb2907b083990b3ef6a16af514ec48/pt/CODING_GUIDELINES.md


--------------------------------------------------------------------------------
/pt/CONTRIBUTING.md:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/race2infinity/The-Documentation-Compendium/272376ad2dfb2907b083990b3ef6a16af514ec48/pt/CONTRIBUTING.md


--------------------------------------------------------------------------------
/pt/ISSUE_TEMPLATES/bug_report.md:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/race2infinity/The-Documentation-Compendium/272376ad2dfb2907b083990b3ef6a16af514ec48/pt/ISSUE_TEMPLATES/bug_report.md


--------------------------------------------------------------------------------
/pt/ISSUE_TEMPLATES/custom.md:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/race2infinity/The-Documentation-Compendium/272376ad2dfb2907b083990b3ef6a16af514ec48/pt/ISSUE_TEMPLATES/custom.md


--------------------------------------------------------------------------------
/pt/ISSUE_TEMPLATES/feature_request.md:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/race2infinity/The-Documentation-Compendium/272376ad2dfb2907b083990b3ef6a16af514ec48/pt/ISSUE_TEMPLATES/feature_request.md


--------------------------------------------------------------------------------
/pt/PULL_REQUEST_TEMPLATE.md:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/race2infinity/The-Documentation-Compendium/272376ad2dfb2907b083990b3ef6a16af514ec48/pt/PULL_REQUEST_TEMPLATE.md


--------------------------------------------------------------------------------
/pt/README_TEMPLATES/Bot.md:
--------------------------------------------------------------------------------
  1 | <p align="center">
  2 |   <a href="" rel="noopener">
  3 |  <img width=200px height=200px src="https://i.imgur.com/FxL5qM0.jpg" alt="Bot logo"></a>
  4 | </p>
  5 | 
  6 | <h3 align="center">Título do Bot</h3>
  7 | 
  8 | <div align="center">
  9 | 
 10 |   [![Status](https://img.shields.io/badge/status-active-success.svg)]()
 11 |   [![Platform](https://img.shields.io/badge/platform-reddit-orange.svg)](https://www.reddit.com/user/Wordbook_Bot)
 12 |   [![GitHub Issues](https://img.shields.io/github/issues/kylelobo/The-Documentation-Compendium.svg)](https://github.com/kylelobo/The-Documentation-Compendium/issues)
 13 |   [![GitHub Pull Requests](https://img.shields.io/github/issues-pr/kylelobo/The-Documentation-Compendium.svg)](https://github.com/kylelobo/The-Documentation-Compendium/pulls)
 14 |   [![License](https://img.shields.io/badge/license-MIT-blue.svg)](/LICENSE)
 15 | 
 16 | </div>
 17 | 
 18 | ---
 19 | 
 20 | <p align="center"> 🤖 Descreva o que seu bot faz em apenas algumas linhas.
 21 |     <br> 
 22 | </p>
 23 | 
 24 | ## 📝 Índice
 25 | + [Sobre](#sobre)
 26 | + [Demonstração / Protótipo](#demonstracao)
 27 | + [Como Funciona](#como_funciona)
 28 | + [Uso](#uso)
 29 | + [Primeiros Passos](#primeiros_passos)
 30 | + [Realizando o Deploying de Seu Próprio Bot](#deployment)
 31 | + [Feito Com](#feito_com)
 32 | + [TODO](../TODO.md)
 33 | + [Contribuiçōes](../CONTRIBUTING.md)
 34 | + [Autores](#autores)
 35 | + [Agradecimentos](#agradecimentos)
 36 | 
 37 | ## 🧐 Sobre <a name = "sobre"></a>
 38 | Escreva entre 1-2 parágrafos uma descriçāo com o propósito do seu bot.
 39 | 
 40 | ## 🎥 Demonstração / Protótipo <a name = "demonstracao"></a>
 41 | ![Como Funciona](https://media.giphy.com/media/20NLMBm0BkUOwNljwv/giphy.gif)
 42 | 
 43 | ## 💭 Como Funciona <a name = "como_funciona"></a>
 44 | Primeiramente, o bot extrái a palavra de um determinado comentário e analíza definiçōes, categoria gramatical, exemplo e fonte para essa palavra na API do Dicionário de Oxford.
 45 | 
 46 | Se essa palavra não existe no Dicionário de Oxford, a API de Oxford retorna uma reposta de erro '404' na qual o bot então tenta filtrar resultados da API do Urban Dictionary.
 47 | 
 48 | Este bot usa a API Pushshift para filtrar comentários, utiliza também o módulo PRAW para responder os comentários e um servidor Horuko para hospedagem.
 49 | 
 50 | Este bot foi escrito usando Python 3.6
 51 | 
 52 | ## 🎈 Uso <a name = "uso"></a>
 53 | 
 54 | Para utilizar o bot, digite:
 55 | ```
 56 | !dict palavra
 57 | ```
 58 | A primeira parte, por exemplo "!dict" **nāo é** sensível a letras maiúsculas e minúsculas.
 59 | 
 60 | 
 61 | O bot entāo vai gerar a definiçāo da palavra (baseado na API do Dicionário de Oxford ou Urban Dictionary) como uma resposta-comentário.  
 62 | 
 63 | ### Exemplo:
 64 | 
 65 | > !dict what is love
 66 | 
 67 | **Definição:**
 68 | 
 69 | Baby, dont hurt me~
 70 | Dont hurt me~ no more.
 71 | 
 72 | **Exemplo:**
 73 | 
 74 | Dude1: Bruh, what is love?
 75 | Dude2: Baby, dont hurt me, dont hurt me- no more!
 76 | Dude1: dafuq?
 77 | 
 78 | **Fonte:** https://www.urbandictionary.com/define.php?term=what%20is%20love
 79 | 
 80 | ---
 81 | 
 82 | <sup>Beep boop. Eu sou um bot. Se surgir algum problema, me contate [Master](https://www.reddit.com/message/compose/?to=PositivePlayer1&subject=/u/Wordbook_Bot)</sup>
 83 | 
 84 | <sup>Tá afim de criar um bot similar? Se liga só: [GitHub](https://github.com/kylelobo/Reddit-Bot)</sup>
 85 | 
 86 | ## 🏁 Primeiros Passos <a name = "primeiros_passos"></a>
 87 | Estas intruçōes te darão uma cópia funcional do projeto na sua máquina local para desenvolvimento e testes. Veja [deployment](#deployment) para uma descrição de como realizar o deployment deste projeto online.
 88 | 
 89 | ### Pré-requisitos
 90 | 
 91 | Descreva o que é necessário para instalar este software e como instalá-lo.
 92 | 
 93 | ```
 94 | Cite exemplos
 95 | ```
 96 | 
 97 | ### Instalacão
 98 | 
 99 | Passo-a-passo com exemplos que reproduzam um estágio de desenvolvimento funcional.
100 | 
101 | Descreva o passo a ser tomado
102 | 
103 | ```
104 | Dê um exemplo
105 | ```
106 | 
107 | Repita
108 | 
109 | ```
110 | Até terminar
111 | ```
112 | 
113 | Finalize com um exemplos de como os dados são processados ou uma pequena demonstração.
114 | 
115 | ## 🚀 Realizando o Deploying de Seu Próprio Bot <a name = "deployment"></a>
116 | Confira um exemplo de como realizar o deployment de seu bot, estas são as minhas configuraçōes:
117 | 
118 | + **Heroku**: https://github.com/kylelobo/Reddit-Bot#deploying_the_bot
119 | 
120 | ## ⛏️ Feito Com <a name = "feito_com"></a>
121 | + [PRAW](https://praw.readthedocs.io/en/latest/) - Python Reddit API Wrapper
122 | + [Heroku](https://www.heroku.com/) - Plataforma de Hospedagem SaaS
123 | 
124 | ## ✍️ Autores <a name = "autores"></a>
125 | + [@kylelobo](https://github.com/kylelobo) - Ideia & Trabalho inicial
126 | 
127 | Confira também a lista de [contribuidores](https://github.com/kylelobo/The-Documentation-Compendium/contributors) que participaram nesse projeto.
128 | 
129 | ## 🎉 Agradecimentos <a name = "agradecimentos"></a>
130 | + Agradecimentos a terceiros, autores ou não de código utilizado nesse projeto.
131 | + Inpiraçōes
132 | + Referêcias
133 | 


--------------------------------------------------------------------------------
/pt/README_TEMPLATES/Hackathon.md:
--------------------------------------------------------------------------------
  1 | <p align="center">
  2 |   <a href="" rel="noopener">
  3 |  <img src="https://i.imgur.com/AZ2iWek.png" alt="Project logo"></a>
  4 | </p>
  5 | <h3 align="center">Título do Projeto</h3>
  6 | 
  7 | <div align="center">
  8 | 
  9 |   [![Hackathon](https://img.shields.io/badge/hackathon-name-orange.svg)](http://hackathon.url.com) 
 10 |   [![Status](https://img.shields.io/badge/status-active-success.svg)]() 
 11 |   [![GitHub Issues](https://img.shields.io/github/issues/kylelobo/The-Documentation-Compendium.svg)](https://github.com/kylelobo/The-Documentation-Compendium/issues)
 12 |   [![GitHub Pull Requests](https://img.shields.io/github/issues-pr/kylelobo/The-Documentation-Compendium.svg)](https://github.com/kylelobo/The-Documentation-Compendium/pulls)
 13 |   [![License](https://img.shields.io/badge/license-MIT-blue.svg)](LICENSE.md)
 14 | 
 15 | </div>
 16 | 
 17 | ---
 18 | 
 19 | <p align="center"> Descreva o seu projeto em algumas linhas.
 20 |     <br> 
 21 | </p>
 22 | 
 23 | ## 📝 Índice
 24 | - [Declaração do Problema](#declaração_problema)
 25 | - [Ideia / Solução](#ideia)
 26 | - [Dependências / Limitaçōes](#limitacoes)
 27 | - [Planos Futuros](#planos_futuros)
 28 | - [Começando](#comecando)
 29 | - [Uso](#uso)
 30 | - [Feito Com](#feito_com)
 31 | - [Contribuição](../CONTRIBUTING.md)
 32 | - [Autores](#autores)
 33 | - [Agradecimentos](#agradecimentos)
 34 | 
 35 | ## 🧐 Declaração do Problema <a name = "declaração_problema"></a>
 36 | Ê importante desenvolver e seguir um formato específico quando se está escrevendo a declaração do problema. Existem várias maneiras de se fazer isso, porém este template à seguir foca em definir o problema de maneira eficaz usando a filosofía de análise de negócios.  
 37 | 
 38 | - IDEAL: Essa parte é usada para descrever o estado no qual o produto estará ao fim do desenvolvimento, baseado no desejo de seus desenvolvedores. É aqui que você deve ilustrar o que esperar do produto uma vez que ele esteja pronto.
 39 | 
 40 | - REALIDADE: Essa parte é usada para descrever o atual estado no processo de produção do produto.
 41 | 
 42 | - CONSEQUÊNCIAS: Essa parte é usada para descrever os impactos caso o problema nāo seja resolvido, ou melhorias não sejam atingidas. Isso inclui custos associados com a perca de dinheiro, tempo, produtividade, competividade, e etc.
 43 | 
 44 | Usar este formato resultará em um documento que pde ser usado para entender o problema em questão e gerará os requerimentos para um solucão eficaz.
 45 | 
 46 | ## 💡 Ideia / Solução <a name = "ideia"></a>
 47 | Já nessa parte, o objetivo é descrever potenciais soluçōes.
 48 | 
 49 | Uma vez que os campos ideal, realidade, e as consequências estejam completos, se torna fácil prover uma soluçāo para um determinado problema.
 50 | 
 51 | ## ⛓️ Dependências / Limitaçōes <a name = "limitacoes"></a>
 52 | - Quais são as dependências de seu projeto?
 53 | 
 54 | - Descreva cada limitação em detalhes mas com termos concisos
 55 | 
 56 | - Explique o porquê de cada limitação
 57 | 
 58 | - Dê a razão pela qual uma determinada limitação não pôde ser resolvida usando os metodos que você descreveu acima
 59 | 
 60 | - Faça uma análise de cada limitação com relação às conclusoōes de seu trabalho e/ou projeto, e, se apropriado, descreva como tais limitaçōes possam beneficiar-se de uma pesquisa mais detalhada.  
 61 | 
 62 | ## 🚀 Planos Futuros <a name = "planos_futuros"></a>
 63 | Escreva sobre as coisas que você não pôde desenvolver durante esta Hackathon; e sobre o quê seu projeto pode atingir no futuro.
 64 | 
 65 | ## 🏁 Começando <a name = "comecando"></a>
 66 | Estas intruçōes te darão uma cópia funcional do projeto na sua máquina local para desenvolvimento e testes. Veja [deployment](#deployment) para uma descrição de como realizar o deployment deste projeto online.
 67 | 
 68 | ### Pré-requisitos
 69 | 
 70 | Descreva o que é necessário para instalar este software e como instalá-lo.
 71 | 
 72 | ```
 73 | Dê exemplos
 74 | ```
 75 | 
 76 | ### Instalação
 77 | 
 78 | Passo-a-passo com exemplos que reproduzam um estágio de desenvolvimento funcional.
 79 | 
 80 | Descreva o passo a ser tomado
 81 | 
 82 | ```
 83 | Dê um exemplo
 84 | ```
 85 | 
 86 | Repita
 87 | 
 88 | ```
 89 | Até terminar
 90 | ```
 91 | 
 92 | ## 🎈 Uso <a name="uso"></a>
 93 | Descreva como utilizar seu app ou sistema.
 94 | 
 95 | ## ⛏️ Feito Com <a name = "feito_com"></a>
 96 | - [MongoDB](https://www.mongodb.com/) - Database
 97 | - [Express](https://expressjs.com/) - Server Framework
 98 | - [VueJs](https://vuejs.org/) - Web Framework
 99 | - [NodeJs](https://nodejs.org/en/) - Server Environment
100 | 
101 | ## ✍️ Autores <a name = "autores"></a>
102 | - [@kylelobo](https://github.com/kylelobo) - Ideia & Trabalho inicial
103 | 
104 | Confira também a lista de [contribuidores](https://github.com/kylelobo/The-Documentation-Compendium/contributors) que participaram nesse projeto.
105 | 
106 | ## 🎉 Agradecimentos <a name = "agradecimentos"></a>
107 | + Agradecimentos a terceiros, autores ou não de código utilizado nesse projeto.
108 | + Inpiraçōes
109 | + Referêcias
110 | 


--------------------------------------------------------------------------------
/pt/README_TEMPLATES/IoT.md:
--------------------------------------------------------------------------------
1 | TODO
2 | 


--------------------------------------------------------------------------------
/pt/README_TEMPLATES/Minimal.md:
--------------------------------------------------------------------------------
 1 | # Título do Projeto
 2 | 
 3 | ## Índice
 4 | + [Sobre](#sobre)
 5 | + [Primeiros Passos](#primeiros_passos)
 6 | + [Uso](#uso)
 7 | + [Contribuiçōes](../CONTRIBUTING.md)
 8 | 
 9 | ## Sobre <a name = "sobre"></a>
10 | Escreva entre 1-2 parágrafos uma descriçāo com o propósito do seu projeto.
11 | 
12 | ## Começando <a name = "comecando"></a>
13 | Estas intruçōes te darão uma cópia funcional do projeto na sua máquina local para desenvolvimento e testes. Veja [deployment](#deployment) para uma descrição de como realizar o deployment deste projeto online.
14 | 
15 | ### Pré-requisitos
16 | 
17 | Descreva o que é necessário para instalar este software e como instalá-lo.
18 | 
19 | ```
20 | Dê exemplos
21 | ```
22 | 
23 | ### Instalação
24 | 
25 | Passo-a-passo com exemplos que reproduzam um estágio de desenvolvimento funcional.
26 | 
27 | Descreva o passo a ser tomado
28 | 
29 | ```
30 | Dê um exemplo
31 | ```
32 | 
33 | Repita
34 | 
35 | ```
36 | Até terminar
37 | ```
38 | 
39 | ## Uso <a name="uso"></a>
40 | Descreva como utilizar seu app ou sistema.
41 | 


--------------------------------------------------------------------------------
/pt/README_TEMPLATES/README.md:
--------------------------------------------------------------------------------
1 | ### Essa pasta contém vários templates README que podem ser utilizados baseado no tipo de projeto.
2 | 
3 | 1. [Bot.md](/README%20Templates/Bot.md) - Para quando você tiver um bot e quiser compartilha-lo com outros usuários.
4 | 2. [Hackathon.md](/README%20Templates/Hackathon.md) - Para quando você estiver em uma hackathon and precisar de uma documentação README elegante que com certeza irá causar um boa impressão nos jurados.
5 | 3. [IoT.md](/README%20Templates/IoT.md) - Esse repo esclarece a parte mais técnica de documentar um projeto IoT.
6 | 4. [Minimal.md](/README%20Templates/Minimal.md) - Um eficiente (e ágil!) template README para o seu projeto.
7 | 5. [Standard.md](/README%20Templates/Standard.md) - Um template README eficáz e detalhado que irá cubrir todos os aspectos macro de seu projeto. 
8 | 


--------------------------------------------------------------------------------
/pt/README_TEMPLATES/Standard.md:
--------------------------------------------------------------------------------
 1 | <p align="center">
 2 |   <a href="" rel="noopener">
 3 |  <img width=200px height=200px src="https://i.imgur.com/6wj0hh6.jpg" alt="Logo do Projeto"></a>
 4 | </p>
 5 | 
 6 | <h3 align="center">Título do Projeto</h3>
 7 | 
 8 | <div align="center">
 9 | 
10 |   [![Status](https://img.shields.io/badge/status-active-success.svg)]() 
11 |   [![GitHub Issues](https://img.shields.io/github/issues/kylelobo/The-Documentation-Compendium.svg)](https://github.com/kylelobo/The-Documentation-Compendium/issues)
12 |   [![GitHub Pull Requests](https://img.shields.io/github/issues-pr/kylelobo/The-Documentation-Compendium.svg)](https://github.com/kylelobo/The-Documentation-Compendium/pulls)
13 |   [![License](https://img.shields.io/badge/license-MIT-blue.svg)](/LICENSE)
14 | 
15 | </div>
16 | 
17 | ---
18 | 
19 | <p align="center"> Descreva o seu projeto em algumas linhas.
20 |     <br> 
21 | </p>
22 | 
23 | ## 📝 Índice
24 | + [Sobre](#sobre)
25 | + [Primeiros Passos](#primeiros_passos)
26 | + [Realizando o Deploying](#deployment)
27 | + [Uso](#uso)
28 | + [Feito Com](#feito_com)
29 | + [TODO](../TODO.md)
30 | + [Contribuição](../CONTRIBUTING.md)
31 | + [Autores](#autores)
32 | + [Agradecimentos](#agradecimentos)
33 | 
34 | ## 🧐 Sobre <a name = "sobre"></a>
35 | Escreva entre 1-2 parágrafos uma descriçāo com o propósito do seu projeto.
36 | 
37 | ## 🏁 Primeiros Passos <a name = "primeiros_passos"></a>
38 | Estas intruçōes te darão uma cópia funcional do projeto na sua máquina local para desenvolvimento e testes. Veja [deployment](#deployment) para uma descrição de como realizar o deployment desse projeto online.
39 | 
40 | ### Pré-requisitos
41 | 
42 | Descreva o que é necessário para instalar este software e como instalá-lo.
43 | 
44 | ```
45 | Cite exemplos
46 | ```
47 | 
48 | ### Instalação
49 | 
50 | Passo-a-passo com exemplos que reproduzam um estágio de desenvolvimento funcional.
51 | 
52 | Descreva o passo a ser tomado
53 | 
54 | ```
55 | Dê um exemplo
56 | ```
57 | 
58 | Repita
59 | 
60 | ```
61 | Até terminar
62 | ```
63 | 
64 | Finalize com um exemplos de como os dados são processados ou uma pequena demonstração.
65 | 
66 | ## 🎈 Uso <a name="uso"></a>
67 | Descreva como utilizar seu app ou sistema.
68 | 
69 | ## 🚀 Realizando o Deploying <a name = "deployment"></a>
70 | Descreva como realizar o deployment de seu projeto.
71 | 
72 | ## ⛏️ Feito Com <a name = "feito_com"></a>
73 | - [MongoDB](https://www.mongodb.com/) - Database
74 | - [Express](https://expressjs.com/) - Server Framework
75 | - [VueJs](https://vuejs.org/) - Web Framework
76 | - [NodeJs](https://nodejs.org/en/) - Server Environment
77 | 
78 | ## ✍️ Autores <a name = "autores"></a>
79 | - [@kylelobo](https://github.com/kylelobo) - Ideia & Trabalho inicial
80 | 
81 | Confira também a lista de [contribuidores](https://github.com/kylelobo/The-Documentation-Compendium/contributors) que participaram nesse projeto.
82 | 
83 | ## 🎉 Agradecimentos <a name = "agradecimentos"></a>
84 | + Agradecimentos a terceiros, autores ou não de código utilizado nesse projeto.
85 | + Inpiraçōes
86 | + Referêcias
87 | 


--------------------------------------------------------------------------------
/pt/TODO.md:
--------------------------------------------------------------------------------
1 | ### TODO
2 | 
3 | ---
4 | 
5 | - [ ] переводить шаблоны
6 | 
7 | 


--------------------------------------------------------------------------------
/ru/CHANGELOG.md:
--------------------------------------------------------------------------------
 1 | # Изменения
 2 | 
 3 | Все заметные изменения в этом проекте будут записаны в этом файле.
 4 | 
 5 | Формат основан на [Как логировать изменения](http://keepachangelog.com/) и этот проект придерживается [семантического управления версиями](http://semver.org/).
 6 | 
 7 | ## [Неизданные] - гггг-мм-дд
 8 | 
 9 | Здесь мы пишем заметки об обновлениях для брендов. Это командное усилие, чтобы сделать их как можно более простыми.
10 | 
11 | ### Добавили
12 | 
13 | - [ИМЯПРОЕКТА-XXXX ](http://tickets.projectname.com/browse/PROJECTNAME-XXXX) НЕЗНАЧИТЕЛЬНОЕ Здесь должно быть название задачи.
14 | - [ИМЯПРОЕКТА-YYYY](http://tickets.projectname.com/browse/PROJECTNAME-YYYY) ИСПРАВЛЕНИЕ Здесь должно быть название задачи.
15 | 
16 | ### Изменили
17 | 
18 | ### Исправили
19 | 
20 | ## [1.2.4] - 15.03.2017
21 | 
22 | Шаги по обновлениям в 1.2.4, которым люди должны следовать.
23 | 
24 | ### Добавили
25 | 
26 | ### Изменили
27 | 
28 | - [ИМЯПРОЕКТА-ZZZZ](http://tickets.projectname.com/browse/PROJECTNAME-ZZZZ) ИСПРАВЛЕНИЕ Drupal.org теперь используется для компоновщика.
29 | 
30 | ### Исправили
31 | 
32 | - [ИМЯПРОЕКТА-TTTT](http://tickets.projectname.com/browse/PROJECTNAME-TTTT) ИСПРАВИЛИ Добавили логику к удалению тизера рабочего листа, чтобы удалить соответствующие карточки расписания.
33 | 
34 | ## [1.2.3] - 14.03.2017
35 | 
36 | ### Добавили
37 | 
38 | ### Изменили
39 | 
40 | ### Исправили
41 | 
42 | - [ИМЯПРОЕКТА-UUUU](http://tickets.projectname.com/browse/PROJECTNAME-UUUU) НЕЗНАЧИТЕЛЬНОЕ Исправлен модуль foo tests.
43 | - [ИМЯПРОЕКТА-RRRR](http://tickets.projectname.com/browse/PROJECTNAME-RRRR) ВАЖНОЕ Модуль Foo использует часовой пояс браузера для выбора даты.
44 | 


--------------------------------------------------------------------------------
/ru/CODEBASE_STRUCTURE.md:
--------------------------------------------------------------------------------
 1 | Это каталоги, которые мы активно используем в разработке:
 2 | 
 3 | - [frontend/server/controllers](https://github.com/kylelobo/The-Documentation-Compendium/tree/master/frontend/server/controllers): Контроллеры выполняют бизнес-логику и предоставляют серверный API.
 4 | - [frontend/server/libs](https://github.com/The-Documentation-Compendium/tree/master/frontend/server/libs): Библиотеки и утилиты.
 5 | - [frontend/server/libs/dao](https://github.com/The-Documentation-Compendium/tree/master/frontend/server/libs/dao): Data Access Objects [DAO] и Value Objects [VO]. Классы, используемые для представления схем базы данных и облегчения их использования контроллерами.
 6 | - [frontend/templates](https://github.com/The-Documentation-Compendium/tree/master/frontend/templates): Шаблоны  Smarty для создания HTML-кода, который отображается пользователям.
 7 | - [frontend/www](https://github.com/The-Documentation-Compendium/tree/master/frontend/www): Полное содержание Интернет-страницы.
 8 | 
 9 | ### Фронтенд / www
10 | 
11 | Содержание:
12 | 
13 | - js /
14 | - css /
15 | 
16 | #### js
17 | 
18 | Как следует из названия, здесь находятся все шрифты javascript и фреймворки javascript. Если вы хотите внести изменения, уменьшите javascript, а затем загрузите.
19 | 
20 | #### css
21 | 
22 | Как и в случае с js, тут уменьшенные файлы css.
23 | 
24 | ### Фронтенд / сервер
25 | 
26 | Содержание:
27 | 
28 | - dao /
29 | - контроллеры /
30 | 
31 | Ни один из этих модулей не должен быть доступен внешнему миру. Единственное, что может их вызвать — это пользовательский интерфейс. Вот почему они находятся в папке www.
32 | 
33 | #### DAO / VO
34 | 
35 | Папка *dao* содержит классы для уровня доступа к данным. Он должен знать 2 вещи: *data access objects* и *value objects*. *Value objects*(VO) — это не что иное, как классы, которые сопоставляются непосредственно с каждой таблицей в базе данных. Поэтому там есть как класс под названием Users, так и таблица с тем же именем. Этот класс имеет свои сеттеры и геттеры для каждого поля в базе данных. *&nbsp;Data access objects*(dao) — являются статическими классами для каждой из таблиц, они служат для получения и создания постоянных объектов *vo*.
36 | 
37 | [Вот больше информации об этой модели](http://www.ibm.com/developerworks/java/library/j-dao/)
38 | 
39 | #### Контроллеры
40 | 
41 | Контроллеры — это то место, где принимаются решения. Контроллер использует dao и vo для принятия решений и никогда не вызывает базу данных напрямую. Таким образом, мы избегаем использования отдельных контроллеров для каждого модуля проекта.
42 | 


--------------------------------------------------------------------------------
/ru/CODE_OF_CONDUCT.md:
--------------------------------------------------------------------------------
 1 | # Кодекс поведения участников Соглашения
 2 | 
 3 | ## Наше обещание
 4 | 
 5 | В интересах создания открытой и доброжелательной среды мы, как участники и сопровождающие, обязуемся сделать участие в нашем проекте и нашем сообществе свободным от преследований для всех, независимо от возраста, размера тела, инвалидности, этнической принадлежности, половых характеристик, гендерной идентичности, самовыражение, уровеня опыта, образования, социально-экономического статус, национальности, внешнего вида, расы, религии или сексуальной идентичности и ориентации.
 6 | 
 7 | ## Наши стандарты
 8 | 
 9 | Примеры поведения, которое способствует созданию благоприятной среды, включают:
10 | 
11 | - Использование приветливого и инклюзивного языка
12 | - Уважительное отношение к различным точкам зрения и опыту
13 | - Изящно принимаю конструктивную критику
14 | - Сосредоточение внимания на том, что лучше для сообщества
15 | - Проявление сочувствия к другим членам сообщества
16 | 
17 | Примеры недопустимого поведения участников включают:
18 | 
19 | - Использование сексуализированной лексики или образов и нежелательное сексуальное внимание или заигрывания
20 | - Троллинг, оскорбительные / уничижительные комментарии, а также личные или политические нападки
21 | - Публичное или частное преследование
22 | - Публикация частной информации других лиц, такой как физический или электронный адрес, без явного разрешения
23 | - Другое поведение, которое можно обоснованно считать неуместным в профессиональной среде.
24 | 
25 | ## Наши обязанности
26 | 
27 | Сопровождающие проекта несут ответственность за разъяснение стандартов приемлемого поведения и от них ожидают принятия соответствующих и справедливых корректирующих действий в ответ на любые случаи неприемлемого поведения.
28 | 
29 | Сопровождающие проекта имеют право и обязаны удалять, редактировать или отклонять комментарии, коммиты, код, правки вики, проблемы и другие материалы, которые не соответствуют настоящему Кодексу поведения, или временно или навсегда заблокировать любого участника за другое поведение, которое они считают неуместным, угрожающим, оскорбительным или вредным.
30 | 
31 | ## Сфера
32 | 
33 | Этот Кодекс поведения применяется как в проектных, так и в общественных местах, когда человек представляет проект или его сообщество. Примеры представления проекта или сообщества включают использование официального адреса электронной почты проекта, размещение сообщений через официальную учетную запись в социальных сетях или выполнение функций назначенного представителя на онлайн- или офлайн-мероприятии. Представление проекта может быть дополнительно определено и уточнено сопровождающими проекта.
34 | 
35 | ## Исполнение
36 | 
37 | О случаях оскорбления, преследования или иного недопустимого поведения можно сообщить, связавшись с командой проекта по адресу kylelobo20@gmail.com. Все жалобы будут рассмотрены и исследованы, и в результате будет дан ответ, который будет сочтен необходимым и соответствующим обстоятельствам. Команда проекта обязана сохранять конфиденциальность в отношении лица, сообщившего об инциденте. Более подробная информация о конкретных правилах применения может быть опубликована отдельно.
38 | 
39 | Сопровождающие проекта, которые не соблюдают и не соблюдают Кодекс поведения добросовестно, могут столкнуться с временными или постоянными последствиями, как это определено другими членами руководства проекта.
40 | 
41 | ## Атрибуция
42 | 
43 | Этот Кодекс поведения адаптирован из [Соглашения для авторов], версия 1.4, доступного по адресу https://www.contributor-covenant.org/version/1/4/code-of-conduct.html.
44 | 
45 | Ответы на распространенные вопросы об этом кодексе поведения см. https://www.contributor-covenant.org/faq.
46 | 
47 | 
48 | [Соглашения для авторов]: https://www.contributor-covenant.org


--------------------------------------------------------------------------------
/ru/CODING_GUIDELINES.md:
--------------------------------------------------------------------------------
 1 | # Гайдлайн по написанию кода
 2 | 
 3 | - Вы можете проверить, соответствует ли ваш код этому гайдлайну, запустив `stuff/php-format.py validate`
 4 | - Табуляция, без пробелов
 5 | - Конец строки должен быть в стиле Unix (`\n`), а не в стиле Windows (`\r\n`)
 6 | - Открывающие скобки находятся в той же строке, что и последний оператор.
 7 | 
 8 | ```
 9 |     if (condition) {
10 |         stuff;
11 |     }
12 | ```
13 | 
14 | - Пробел между ключевыми словами и круглыми скобками для: `if`, `else`, `while`, `switch`, `catch`, `function`
15 | - В вызовах функций нет пробела перед круглыми скобками
16 | - В скобках нет пробелов
17 | - Пробел после каждой запятой, но без пробела перед
18 | - Все бинарные операторы должны иметь один пробел до и один после
19 | - Не должно быть более одной непрерывной пустой строки
20 | - Пустых комментариев быть не должно
21 | - Вы не должны использовать блоки комментариев `/ * ... * /`, только строку `// ...`
22 | - Изменения в функциональности должны сопровождаться соответствующими новыми/ модифицированными тестами
23 | - Исключения должны использоваться для сообщения об ошибочных состояниях. Использование функций, возвращающих true/false, разрешено, когда они являются ожидаемыми значениями
24 | - При необходимости используйте [RAII] (http://en.wikipedia.org/wiki/Resource_Acquisition_Is_Initialization), в основном при администрировании ресурсов (файлов и т. д.)
25 | 


--------------------------------------------------------------------------------
/ru/CONTRIBUTING.md:
--------------------------------------------------------------------------------
 1 | # Руководство по участию
 2 | 
 3 | - Пополнить The Documentation Compendium довольно просто. В этом документе показано, как начать работу
 4 | 
 5 | ## Общее
 6 | 
 7 | - [Структура кодовой базы ](./CODEBASE_STRUCTURE.md) содержит подробную информацию о том, как структурированы различные файлы в этом проекте
 8 | - Пожалуйста, убедитесь, что любые внесенные вами изменения соответствуют [Гайдлайну по написанию кода](./CODING_GUIDELINES.md) этого репозитория
 9 | 
10 | ## Отправка изменений
11 | 
12 | - Сделайте форк репозитория
13 |     - [https://github.com/kylelobo/The-Documentation-Compendium/fork](https://github.com/kylelobo/The-Documentation-Compendium/fork)
14 | - Проверьте новую ветку и назовите ее в соответствии с тем, что вы собираетесь делать:
15 |     - Пример:
16 |         ```
17 |         $ git checkout -b BRANCH_NAME
18 |         ```
19 |         Если вы получите сообщение об ошибке, вам может потребоваться сначала получить fooBar, используя
20 |         ```
21 |         $ git remote update && git fetch
22 |         ```
23 |     - Используйте одну ветку для каждого исправления / добавления
24 | - Закоммитьте свои изменения
25 |     - Пожалуйста, предоставьте git сообщение, объясняющее, что вы сделали
26 |     - Пожалуйста, убедитесь, что ваши коммиты соответствуют [соглашениям](https://gist.github.com/robertpainsi/b632364184e70900af4ab688decf6f53#file-commit-message-guidelines-md)
27 |     - Закоммите в репозитории
28 |     - Пример:
29 |         ```
30 |         $ git commit -am 'Add some fooBar'
31 |         ```
32 | - Запуште в ветку
33 |     - Пример:
34 |         ```
35 |         $ git push origin BRANCH_NAME
36 |         ```
37 | - Сделать пул реквест
38 |     - Убедитесь, что вы отправили пул реквест в ветку <code>fooBar</code>
39 |     - Travis CI наблюдает за тобой!
40 | 
41 | Если вы будете следовать этим инструкциям, ваш пул реквест довольно безопасно попадет в основной репозиторий!
42 | 


--------------------------------------------------------------------------------
/ru/ISSUE_TEMPLATES/bug_report.md:
--------------------------------------------------------------------------------
 1 | ---
 2 | Имя: Отчет об ошибке
 3 | О чем: Создайте отчет, который поможет нам стать лучше
 4 | Заголовок:
 5 | Лэйблы:
 6 | Исполнители:
 7 | ---
 8 | 
 9 | **Опишите ошибку** Четкое и краткое описание ошибки.
10 | 
11 | **Как воспроизвести** Шаги для воспроизведения:
12 | 
13 | 1. Перейдите к '...'
14 | 2. Нажмите на '....'
15 | 3. Прокрутите вниз до "...."
16 | 4. Увидите ошибку
17 | 
18 | **Ожидаемое поведение** Четкое и краткое описание того, что вы ожидали.
19 | 
20 | **Скриншоты** Если возможно, добавьте скриншоты, которые помогут объяснить вашу проблему.
21 | 
22 | **<strong>Компьютер (заполните следующую информацию):</strong>**
23 | 
24 | - ОС: [например, iOS]
25 | - Браузер [например, Chrome, Safari]
26 | - Версия [например, 22]
27 | 
28 | **<strong>Смартфон (заполните следующую информацию):</strong>**
29 | 
30 | - Устройство: [например, iPhone6]
31 | - ОС: [например, iOS8.1]
32 | - Браузер [например, стандартный браузер, Safari]
33 | - Версия [например, 22]
34 | 
35 | **Дополнительный контекст** Добавьте сюда дополнительную информацию о проблеме.
36 | 


--------------------------------------------------------------------------------
/ru/ISSUE_TEMPLATES/custom.md:
--------------------------------------------------------------------------------
1 | ---
2 | Имя: Шаблон задачи
3 | О чем: Опишите здесь цель этого шаблона задачи.
4 | Заголовок:
5 | Лэйблы:
6 | Исполнители:
7 | ---
8 | 


--------------------------------------------------------------------------------
/ru/ISSUE_TEMPLATES/feature_request.md:
--------------------------------------------------------------------------------
 1 | ---
 2 | Имя: Предложение
 3 | О чем: Предложите идею для этого проекта
 4 | Заголовок:
 5 | Лэйблы:
 6 | Исполнители:
 7 | ---
 8 | 
 9 | **Связано ли ваше предложение с проблемой? Пожалуйста, опишите.** Четкое и краткое описание проблемы. Пример: Я всегда расстраиваюсь, когда [...]
10 | 
11 | **Ожидаемое поведение** Четкое и краткое описание того, что вы ожидали.
12 | 
13 | **Опишите альтернативы, которые вы рассмотрели.** Четкое и краткое описание любых альтернативных решений или возможностей, которые вы рассмотрели.
14 | 
15 | **Дополнительный контекст** Добавьте сюда любой другой контекст или скриншоты.
16 | 


--------------------------------------------------------------------------------
/ru/PULL_REQUEST_TEMPLATE.md:
--------------------------------------------------------------------------------
 1 | ### Ваш чек-лист для пул реквеста
 2 | 
 3 | 🚨 Пожалуйста, ознакомьтесь с принципами по внесению изменений в этот репозиторий.
 4 | 
 5 | - [ ] Убедитесь, что вы запрашиваете пул реквест для ветки темы/возможности/исправления ошибок (справа). Не запрашивайте для ветки мастер!
 6 | - [ ] Убедитесь, что вы делаете запрос на пул реквест для ветки fooBar (слева).
 7 | - [ ] Проверьте, что стили сообщений коммита или даже всех коммитов соответствуют нашей запрошенной структуре.
 8 | - [ ] Проверьте, что ваши изменения пройдут проверку линтинга кода и юнит-тестирование.
 9 | 
10 | ### Описание
11 | 
12 | Пожалуйста, опишите свой пул реквест.
13 | 
14 | ❤️ Спасибо!
15 | 


--------------------------------------------------------------------------------
/ru/README_TEMPLATES/Bot.md:
--------------------------------------------------------------------------------
  1 | <p align="center"><a href="" rel="noopener">  </a><img width="200px" height="200px" src="https://i.imgur.com/FxL5qM0.jpg" alt="Логотип бота"></p>
  2 | 
  3 | <h3 align="center">Имя бота</h3>
  4 | 
  5 | <div align="center">
  6 | </div>
  7 | 
  8 | []()![Статус](https://img.shields.io/badge/status-active-success.svg)
  9 | 
 10 | 
 11 | 
 12 | 
 13 | ---
 14 | 
 15 | <p align="center">🤖 Несколько строк, описывающих, что делает ваш бот.<br></p>
 16 | 
 17 | ## 📝 Содержание
 18 | 
 19 | - [О боте](#about)
 20 | - [Демо/Работа](#demo)
 21 | - [Как это устроено](#working)
 22 | - [Применение](#usage)
 23 | - [Начало работы](#getting_started)
 24 | - [Развертывание собственного бота](#deployment)
 25 | - [Построен с использованием](#built_using)
 26 | - [To Do](../TODO.md)
 27 | - [Участие](../CONTRIBUTING.md)
 28 | - [Авторы](#authors)
 29 | - [Благодарности](#acknowledgement)
 30 | 
 31 | ## 🧐 <a name="about">О боте</a>
 32 | 
 33 | Напишите примерно 1-2 абзаца, описывающих назначение вашего бота.
 34 | 
 35 | ## 🎥 Демо / Работа<a name="demo"></a>
 36 | 
 37 | ![За работой](https://media.giphy.com/media/20NLMBm0BkUOwNljwv/giphy.gif)
 38 | 
 39 | ## 💭 Как это работает<a name="working"></a>
 40 | 
 41 | Бот сначала извлекает слово из комментария, а затем извлекает определения слова, часть речи, пример и источник из Oxford Dictionary API.
 42 | 
 43 | Если этого слова нет в Оксфордском словаре, Oxford API возвращает ответ 404, после чего бот пытается получить результаты из API Urban Dictionary.
 44 | 
 45 | Бот использует Pushshift API для получения комментариев, модуль PRAW для ответа на комментарии и Heroku в качестве сервера.
 46 | 
 47 | Весь бот написан на Python 3.6.
 48 | 
 49 | ## 🎈 Использование<a name="usage"></a>
 50 | 
 51 | Чтобы использовать бот, введите:
 52 | 
 53 | ```
 54 | !dict word
 55 | ```
 56 | 
 57 | Первая часть, т.е. "!dict", **не** чувствительна к регистру.
 58 | 
 59 | Затем бот предоставит вам определение слова в Оксфордском словаре (или Urban Dictionary, если слово не существует в Оксфордском словаре) в качестве ответа на комментарий.
 60 | 
 61 | ### Пример:
 62 | 
 63 | > !dict что такое любовь
 64 | 
 65 | **Определение:**
 66 | 
 67 | Детка, не делай мне больно ~ Не делай мне больно ~ больше.
 68 | 
 69 | **Пример:**
 70 | 
 71 | Чувак1: Бро, что такое любовь? Чувак2: Детка, не делай мне больно, не больно мне больше! Чувай1: Чего?
 72 | 
 73 | **Источник:** https://www.urbandictionary.com/define.php?term=what%20is%20love.
 74 | 
 75 | ---
 76 | 
 77 | <sup>Бип-буп. Я бот. Если есть какие-либо вопросы, свяжитесь с моим <a href="https://www.reddit.com/message/compose/?to=PositivePlayer1&subject=/u/Wordbook_Bot">Мастером</a></sup>
 78 | 
 79 | <sup>Хотите сделать похожего бота на Reddit? Проверьте: <a href="https://github.com/kylelobo/Reddit-Bot">GitHub</a></sup>
 80 | 
 81 | ## 🏁 Начало работы<a name="getting_started"></a>
 82 | 
 83 | Эти инструкции позволят вам запустить копию проекта на локальном компьютере в целях разработки и тестирования. К ак развернуть проект в действующей системе описано в разделе [Развертывание](#deployment).
 84 | 
 85 | ### Предпосылки
 86 | 
 87 | Что нужно для установки программного обеспечения и как их установить.
 88 | 
 89 | ```
 90 | Give examples
 91 | ```
 92 | 
 93 | ### Установка
 94 | 
 95 | Пошаговая серия примеров, рассказывающих, как запустить среду разработки.
 96 | 
 97 | Скажите, какой будет шаг
 98 | 
 99 | ```
100 | Give the example
101 | ```
102 | 
103 | И повторить
104 | 
105 | ```
106 | until finished
107 | ```
108 | 
109 | Закончите примером получения некоторых данных из системы или использования их для небольшой демонстрации.
110 | 
111 | ## 🚀 Развертывание собственного бота<a name="deployment"></a>
112 | 
113 | Чтобы увидеть пример проекта по развертыванию бота, просмотрите мою собственную конфигурацию:
114 | 
115 | - **Heroku** : https://github.com/kylelobo/Reddit-Bot#deploying_the_bot
116 | 
117 | ## ⛏️ Построен с использованием<a name="built_using"></a>
118 | 
119 | - [PRAW](https://praw.readthedocs.io/en/latest/) — Python Reddit API Wrapper
120 | - [Heroku](https://www.heroku.com/) —хостинговая платформа SaaS
121 | 
122 | ## ✍️ Авторы<a name="authors"></a>
123 | 
124 | - [@kylelobo](https://github.com/kylelobo) — Идея и начальная работа
125 | 
126 | Список [участников](https://github.com/kylelobo/The-Documentation-Compendium/contributors), работавших в этом проекте.
127 | 
128 | ## 🎉 Благодарности<a name="acknowledgement"></a>
129 | 
130 | - Спасибо всем, чей код использовался
131 | - Вдохновение
132 | - Ссылки
133 | 


--------------------------------------------------------------------------------
/ru/README_TEMPLATES/Hackathon.md:
--------------------------------------------------------------------------------
  1 | <p align="center"><a href="" rel="noopener">  </a><img src="https://i.imgur.com/AZ2iWek.png" alt="Логотип проекта"></p>
  2 | <h3 align="center">Название Проекта</h3>
  3 | 
  4 | <div align="center">
  5 | </div>
  6 | 
  7 | [](http://hackathon.url.com)![Хакатон](https://img.shields.io/badge/hackathon-name-orange.svg)
  8 | 
  9 | 
 10 | 
 11 | 
 12 | ---
 13 | 
 14 | <p align="center">Несколько строк, описывающих ваш проект.<br></p>
 15 | 
 16 | ## 📝 Содержание
 17 | 
 18 | - [Постановка задачи](#problem_statement)
 19 | - [Идея/Решение](#idea)
 20 | - [Зависимости/Ограничения](#limitations)
 21 | - [Планы на будущее](#future_scope)
 22 | - [Настройка локальной среды](#getting_started)
 23 | - [Применение](#usage)
 24 | - [Стек технологий](#tech_stack)
 25 | - [Участие](../CONTRIBUTING.md)
 26 | - [Авторы](#authors)
 27 | - [Благодарности](#acknowledgments)
 28 | 
 29 | ## 🧐 Постановка задачи<a name="problem_statement"></a>
 30 | 
 31 | При написании постановки задачи полезно разработать и придерживаться определенного формата. Хотя для этого есть несколько вариантов, ниже представлен простой и понятный шаблон, который часто используется в бизнес-аналитике, чтобы сосредоточиться на определении проблемы.
 32 | 
 33 | - ИДЕАЛЬНО: Этот раздел используется для описания желаемого или «будущего» состояния процесса или продукта. В целом этот раздел должен проиллюстрировать, как будет выглядеть ожидаемая среда после реализации решения.
 34 | - РЕАЛЬНОСТЬ: Этот раздел используется для описания текущего или «как есть» состояния процесса или продукта.
 35 | - ПОСЛЕДСТВИЯ. Этот раздел используется для описания воздействия на бизнес, если проблема не будет устранена или улучшена. Сюда входят затраты, связанные с потерей денег, времени, производительности, конкурентного преимущества и т.д.
 36 | 
 37 | Следование этому формату приведет к созданию работоспособного документа, который можно использовать для понимания проблемы и выявления требований, которые приведут к выигрышному решению.
 38 | 
 39 | ## 💡 Идея / Решение<a name="idea"></a>
 40 | 
 41 | Этот раздел используется для описания возможных решений.
 42 | 
 43 | После того, как разделы об идеале, реальности и последствиях завершены и поняты, становится проще найти решение проблемы.
 44 | 
 45 | ## ⛓️ Зависимости / ограничения<a name="limitations"></a>
 46 | 
 47 | - Каковы зависимости вашего проекта?
 48 | - Опишите каждое ограничение подробно, но кратко
 49 | - Объясните, почему существует каждое ограничение
 50 | - Укажите причины, по которым каждое ограничение не может быть преодолено с помощью метода(ов), выбранного для приобретения
 51 | - Оцените влияние каждого ограничения на общие результаты и выводы вашего проекта и, если это уместно, опишите, как эти ограничения могут указывать на необходимость дальнейших исследований.
 52 | 
 53 | ## 🚀 <a name="future_scope">Планы на будущее</a>
 54 | 
 55 | Напишите о том, чего вы не смогли разработать в ходе Хакатона; и о том, чего может достичь ваш проект в будущем.
 56 | 
 57 | ## 🏁 Начало работы<a name="getting_started"></a>
 58 | 
 59 | Эти инструкции позволят вам запустить копию проекта на локальном компьютере в целях разработки и тестирования. К ак развернуть проект в действующей системе описано в разделе [Развертывание](#deployment).
 60 | 
 61 | ### Предпосылки
 62 | 
 63 | Что нужно для установки программного обеспечения и как их установить.
 64 | 
 65 | ```
 66 | Give examples
 67 | ```
 68 | 
 69 | ### Установка
 70 | 
 71 | Пошаговая серия примеров, рассказывающих, как запустить среду разработки.
 72 | 
 73 | Скажите, какой будет шаг
 74 | 
 75 | ```
 76 | Give the example
 77 | ```
 78 | 
 79 | И повторить
 80 | 
 81 | ```
 82 | until finished
 83 | ```
 84 | 
 85 | ## 🎈 Использование<a name="usage"></a>
 86 | 
 87 | Добавьте примечания о том, как использовать систему.
 88 | 
 89 | ## ⛏️ <a name="tech_stack">Стек технологий</a>
 90 | 
 91 | - [MongoDB](https://www.mongodb.com/) — База данных
 92 | - [Express](https://expressjs.com/) — Серверная структура
 93 | - [VueJs](https://vuejs.org/) — Веб-фреймворк
 94 | - [NodeJs](https://nodejs.org/en/) — Серверная среда
 95 | 
 96 | ## ✍️ Авторы<a name="authors"></a>
 97 | 
 98 | - [@kylelobo](https://github.com/kylelobo) — Идея и начальная работа
 99 | 
100 | Список [участников](https://github.com/kylelobo/The-Documentation-Compendium/contributors), работавших в этом проекте.
101 | 
102 | ## 🎉 Благодарности<a name="acknowledgments"></a>
103 | 
104 | - Спасибо всем, чей код использовался
105 | - Вдохновение
106 | - Ссылки
107 | 


--------------------------------------------------------------------------------
/ru/README_TEMPLATES/IoT.md:
--------------------------------------------------------------------------------
1 | TODO
2 | 


--------------------------------------------------------------------------------
/ru/README_TEMPLATES/Minimal.md:
--------------------------------------------------------------------------------
 1 | # Название Проекта
 2 | 
 3 | ## Оглавление
 4 | 
 5 | - [О проекте](#about)
 6 | - [Начало работы](#getting_started)
 7 | - [Применение](#usage)
 8 | - [Участие](../CONTRIBUTING.md)
 9 | 
10 | ## <a name="about">О проекте</a>
11 | 
12 | Напишите примерно 1-2 абзаца, описывающих цель вашего проекта.
13 | 
14 | ## <a name="getting_started">Начало работы</a>
15 | 
16 | Эти инструкции позволят вам запустить копию проекта на локальном компьютере в целях разработки и тестирования. Как развернуть проект в действующей системе описано в разделе [Развертывание](#deployment).
17 | 
18 | ### Предпосылки
19 | 
20 | Что нужно для установки программного обеспечения и как его установить.
21 | 
22 | ```
23 | Give examples
24 | ```
25 | 
26 | ### Установка
27 | 
28 | Пошаговая серия примеров, рассказывающих, как запустить среду разработки.
29 | 
30 | Скажите, какой будет шаг
31 | 
32 | ```
33 | Give the example
34 | ```
35 | 
36 | И повторите
37 | 
38 | ```
39 | until finished
40 | ```
41 | 
42 | Закончите примером получения некоторых данных из системы и использования их для небольшой демонстрации.
43 | 
44 | ## Применение<a name="usage"></a>
45 | 
46 | Добавьте примечания о том, как использовать систему.
47 | 


--------------------------------------------------------------------------------
/ru/README_TEMPLATES/README.md:
--------------------------------------------------------------------------------
1 | ### This folder contains various README Templates that one can use based on the type of project.
2 | 
3 | 1. [Bot.md](/README%20Templates/Bot.md) - 
4 | 2. [Hackathon.md](/README%20Templates/Hackathon.md) - 
5 | 3. [IoT.md](/README%20Templates/IoT.md) - 
6 | 4. [Minimal.md](/README%20Templates/Minimal.md) - 
7 | 5. [Standard.md](/README%20Templates/Standard.md) - 
8 | 


--------------------------------------------------------------------------------
/ru/README_TEMPLATES/Standard.md:
--------------------------------------------------------------------------------
  1 | <p align="center"><a href="" rel="noopener">  </a><img width="200px" height="200px" src="https://i.imgur.com/6wj0hh6.jpg" alt="Логотип проекта"></p>
  2 | 
  3 | <h3 align="center">Название Проекта</h3>
  4 | 
  5 | <div align="center">
  6 | </div>
  7 | 
  8 | []()![Статус](https://img.shields.io/badge/status-active-success.svg)
  9 | 
 10 | 
 11 | 
 12 | 
 13 | ---
 14 | 
 15 | <p align="center">Несколько строк, описывающих ваш проект.<br></p>
 16 | 
 17 | ## 📝 Содержание
 18 | 
 19 | - [О проекте](#about)
 20 | - [Начало работы](#getting_started)
 21 | - [Развертывание](#deployment)
 22 | - [Применение](#usage)
 23 | - [Построен с использованием](#built_using)
 24 | - [To Do](../TODO.md)
 25 | - [Участие](../CONTRIBUTING.md)
 26 | - [Авторы](#authors)
 27 | - [Благодарности](#acknowledgement)
 28 | 
 29 | ## 🧐 <a name="about">о проекте</a>
 30 | 
 31 | Напишите примерно 1-2 абзаца, описывающих цель вашего проекта.
 32 | 
 33 | ## 🏁 Начало работы<a name="getting_started"></a>
 34 | 
 35 | Эти инструкции позволят вам запустить копию проекта на локальном компьютере в целях разработки и тестирования. К ак развернуть проект в действующей системе описано в разделе [Развертывание](#deployment).
 36 | 
 37 | ### Предпосылки
 38 | 
 39 | Что нужно для установки программного обеспечения и как их установить.
 40 | 
 41 | ```
 42 | Give examples
 43 | ```
 44 | 
 45 | ### Установка
 46 | 
 47 | Пошаговая серия примеров, рассказывающих, как запустить среду разработки.
 48 | 
 49 | Скажите, какой будет шаг
 50 | 
 51 | ```
 52 | Give the example
 53 | ```
 54 | 
 55 | И повторите
 56 | 
 57 | ```
 58 | until finished
 59 | ```
 60 | 
 61 | Закончите примером получения некоторых данных из системы или использования их для небольшой демонстрации.
 62 | 
 63 | ## 🔧 Запуск тестов<a name="tests"></a>
 64 | 
 65 | Объясните, как запустить автоматические тесты для этой системы.
 66 | 
 67 | ### Разбейте на сквозные тесты
 68 | 
 69 | Объясните, что проверяют эти тесты и почему
 70 | 
 71 | ```
 72 | Give an example
 73 | ```
 74 | 
 75 | ### И тесты стиля кода
 76 | 
 77 | Объясните, что проверяют эти тесты и почему
 78 | 
 79 | ```
 80 | Give an example
 81 | ```
 82 | 
 83 | ## 🎈 Использование<a name="usage"></a>
 84 | 
 85 | Добавьте примечания о том, как использовать систему.
 86 | 
 87 | ## 🚀 Развертывание<a name="deployment"></a>
 88 | 
 89 | Добавьте дополнительные примечания о том, как развернуть это в действующей системе.
 90 | 
 91 | ## ⛏️ Построен с использованием<a name="built_using"></a>
 92 | 
 93 | - [MongoDB](https://www.mongodb.com/) — База данных
 94 | - [Express](https://expressjs.com/) — Серверная структура
 95 | - [VueJs](https://vuejs.org/) — Веб-фреймворк
 96 | - [NodeJs](https://nodejs.org/en/) — Серверная среда
 97 | 
 98 | ## ✍️ Авторы<a name="authors"></a>
 99 | 
100 | - [@kylelobo](https://github.com/kylelobo) — Идея и начальная работа
101 | 
102 | Список [участников](https://github.com/kylelobo/The-Documentation-Compendium/contributors), работавших в этом проекте.
103 | 
104 | ## 🎉 Благодарности<a name="acknowledgement"></a>
105 | 
106 | - Спасибо всем, чей код использовался
107 | - Вдохновение
108 | - Ссылки
109 | 


--------------------------------------------------------------------------------
/ru/TODO.md:
--------------------------------------------------------------------------------
 1 | ### <a>To Do</a>
 2 | 
 3 | ---
 4 | 
 5 | - [x] Создать README.md файл в папке [README_TEMPLATES](./README_TEMPLATES).
 6 | - [ ] Создать шаблон IoT (за помощью обратитесь к документации по различным проектам Arduino). Этот шаблон должен быть подробным и должен углубляться в различные аппаратные термины.
 7 | - [ ] Сделайте минимальный шаблон IoT.
 8 | - [ ] Добавить файл COMMIT_MESSAGE_GUIDELINES.md.
 9 | - [ ] Перевести [шаблоны](https://github.com/kylelobo/The-Documentation-Compendium#templates) на разные языки — китайский, французский, немецкий, хинди, итальянский, японский, корейский, португальский, русский, испанский и т. д.
10 | 


--------------------------------------------------------------------------------