Skip to content

Commit

Permalink
Creating Initial Draft of issue templates (#34)
Browse files Browse the repository at this point in the history
* Creating Initial Draft of issue templates

Issue Templates to aid with docs_update

* Update bug-or-error-report.md

* Update bug-or-error-report.md

Minor typos

* Proofread bug-or-error-report.md, updated phrasing in some places

---------

Co-authored-by: Chad Poland <[email protected]>
Co-authored-by: Linda Waterhouse <[email protected]>
Co-authored-by: mitchelbaker-cisa <[email protected]>
  • Loading branch information
4 people authored Nov 17, 2023
1 parent 0c24d6e commit 0661dfc
Show file tree
Hide file tree
Showing 2 changed files with 79 additions and 0 deletions.
59 changes: 59 additions & 0 deletions .github/ISSUE_TEMPLATE/bug-or-error-report.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,59 @@
---
name: Bug or Error report
about: Report issues, mistakes, unsolvable, or unresolved errors to help improve the project
title: "[BUG] ERROR YYYYY in step X.X"
labels: bug
assignees: ''

---

## **BEFORE CREATING THE ISSUE, CHECK THE FOLLOWING GUIDES**:
- [ ] [FAQ](https://github.com/cisagov/LME/blob/main/docs/markdown/reference/faq.md)
- [ ] [Troubleshooting](https://github.com/cisagov/LME/blob/main/docs/markdown/reference/troubleshooting.md)
- [ ] Search current/closed issues for similar questions, and utilize github/google search to see if an answer exists for the error I'm encountering.

If the above did not answer your question, proceed with creating an issue below:

## Describe the bug
A clear and concise description of what the bug is.

## To Reproduce
Steps to reproduce the behavior. These should be clear enough that our team can understand your running environment, software/operating system versions, and anything else we might need to debug the issue.

An example of a usable reproducible list are shown in these issues: [Issue 1](https://github.com/cisagov/LME/issues/15) [Issue 2](https://github.com/cisagov/LME/issues/19).

To increase the speed and relevance of the reply we suggest you list down debugging steps you have tried, as well as the following information:

### Please complete the following information
**Desktop:**
- OS: [e.g. Windows 10]
- Browser: [e.g. Firefox Version 104.0.1]
- Software version: [e.g. Sysmon v15.0, Winlogbeat 8.11.1]

**Server:**
- OS: [e.g. Ubuntu 22.04]
- Software Versions:
- ELK: [e.g. 8.7.1]
- Docker: [e.g. 20.10.23, build 7155243]
- The output of these commands:
```
free -h
df -h
uname -a
lsb_release -a
```
- Relevant container logs:
```
for name in $(sudo docker ps -a --format '{{.Names}}'); do echo -e "\n\n\n-----------$name----------"; sudo docker logs $name | tail -n 20; done
```
Increase the number of lines if your issue is not present, or include a relevant log of the erroring container
- Output of the relevant /var/log/cron_logs/ file

## Expected behavior
A clear and concise description of what you expected to happen.

## Screenshots
If applicable, add screenshots to help explain your problem.

## Additional context
Add any other context about the problem here.
20 changes: 20 additions & 0 deletions .github/ISSUE_TEMPLATE/feature_request.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
---
name: Feature request
about: Suggest an idea for this project
title: ''
labels: ''
assignees: ''

---

**Is your feature request related to a problem? Please describe.**
A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]

**Describe the solution you'd like**
A clear and concise description of what you want to happen.

**Describe alternatives you've considered**
A clear and concise description of any alternative solutions or features you've considered.

**Additional context**
Add any other context or screenshots about the feature request here.

0 comments on commit 0661dfc

Please sign in to comment.