~aleteoryx/muditaos

9fdb735a0506f10e13f76fc1bfe3ef177360f912 — Wojtek CichoΕ„ 5 years ago 32ead4a
[EGD-4511] Added GitHub issue templates (#1085)

Add nice-looking GitHub issue templates

Added 3 new GitHub Issue templates (bug, feature, docs) so that
the future OSS community will be guided by the hand in creating 
issues on the repo properly. 
A .github/issue_template/1-bug-report.md => .github/issue_template/1-bug-report.md +35 -0
@@ 0,0 1,35 @@
---
name: "πŸ› Bug report"
about: Report a bug in MuditaOS
---
# πŸ› Bug report

## πŸ“ Description

A clear and concise description of the problem...

## πŸ‘ Expected behavior

What you think should happen...

## πŸ‘Ž Current behavior

Current 'buggy' behavior...

## πŸ”¬ Minimal reproduction

Simple steps to reproduce this bug.

Issues that don't have enough info and can't be reproduced will be closed.

## πŸ” Provide logs

Please paste relevant logs below or attach them to this issue.

<pre><code>

</code></pre>

## 🌍 Your operating system and MuditaOS version

## πŸ€” Anything else relevant?
\ No newline at end of file

A .github/issue_template/2-feature-request.md => .github/issue_template/2-feature-request.md +18 -0
@@ 0,0 1,18 @@
---
name: "πŸš€ Feature request"
about: Suggest a feature for MuditaOS

---
# πŸš€ Feature request

## πŸ“ Description

A clear and concise description of the problem or missing capability...

## πŸ“ Describe the solution you'd like

If you have a solution in mind, please describe it.

## πŸ“ Describe alternatives you've considered

Have you considered any alternative solutions or workarounds?

A .github/issue_template/3-docs-bug.md => .github/issue_template/3-docs-bug.md +19 -0
@@ 0,0 1,19 @@
---
name: "πŸ“š Missing or unclear documentation"
about: Report an issue in MuditaOS documentation

---

#  πŸ“š Missing or unclear documentation

## πŸ“ Description

A clear and concise description of the problem or missing documentation.

## πŸ“ Describe the solution you'd like

If you have a solution in mind, please describe it.

## πŸ”— Link to an article that could be improved

Please support us with the link to the current article that could be improved.

M README.md => README.md +1 -1
@@ 104,4 104,4 @@ firefox build-<target>-<build_type>/doc/html/index.html
The [MuditaOS changelog](./changelog.md) is regularly updated by the core development team.

## License
MuditaOS is licensed on [GNU GPLv3](https://choosealicense.com/licenses/gpl-3.0/).
MuditaOS is licensed under [GNU GPLv3](https://choosealicense.com/licenses/gpl-3.0/).