Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
123 changes: 123 additions & 0 deletions .github/ISSUE_TEMPLATE/bug_report.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,123 @@
---
name: πŸ› Bug Report
about: Report a bug or issue with Rover
title: '[BUG] '
labels: ['bug', 'triage']
assignees: []

---

## πŸ› Bug Description

A clear and concise description of what the bug is.

## πŸ”„ Steps to Reproduce

1. Go to '...'
2. Run command '...'
3. Set configuration '...'
4. See error

## βœ… Expected Behavior

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

## ❌ Actual Behavior

A clear and concise description of what actually happened.

## πŸ–ΌοΈ Screenshots/Logs

If applicable, add screenshots or logs to help explain your problem.

```
Paste error logs here
```

## 🌍 Environment Information

Please complete the following information:

**Host System:**
- OS: [e.g., Ubuntu 20.04, Windows 11, macOS 12]
- Docker Version: [e.g., 20.10.17]
- Architecture: [e.g., x64, arm64]

**Rover:**
- Rover Version: [e.g., 1.3.0]
- Container Image: [e.g., aztfmod/rover:latest]
- Installation Method: [e.g., Docker Hub, Local Build]

**Azure:**
- Azure CLI Version: [e.g., 2.40.0]
- Subscription Type: [e.g., Free Trial, Pay-As-You-Go, Enterprise]
- Authentication Method: [e.g., Interactive, Service Principal, Managed Identity]

**Terraform:**
- Terraform Version: [e.g., 1.3.0]
- Provider Versions: [e.g., azurerm 3.20.0]

## πŸ”§ Configuration

**Landing Zone:**
- Level: [e.g., level0, level1, level2]
- Environment: [e.g., dev, staging, production]
- Custom Configuration: [Yes/No]

**Command Used:**
```bash
# Paste the exact rover command that caused the issue
rover -lz ./landingzone -a apply -env production
```

**Terraform Configuration:**
```hcl
# Include relevant terraform configuration if applicable
# Remove any sensitive information
```

## πŸ•΅οΈ Diagnostic Information

Please run the diagnostic script and paste the output:

```bash
# Run this diagnostic script and paste output
curl -s https://raw.githubusercontent.com/aztfmod/rover/main/scripts/diagnostics.sh | bash
```

<details>
<summary>Diagnostic Output</summary>

```
Paste diagnostic output here
```

</details>

## πŸ” Additional Context

Add any other context about the problem here.

- Have you encountered this issue before? [Yes/No]
- Does this issue occur consistently? [Yes/No]
- Any recent changes to your environment? [Yes/No - describe]
- Are you using any custom configurations? [Yes/No - describe]

## πŸ“‹ Checklist

Before submitting this issue, please confirm:

- [ ] I have searched existing issues to avoid duplicates
- [ ] I have included all required environment information
- [ ] I have included the exact error message and/or logs
- [ ] I have included steps to reproduce the issue
- [ ] I have removed any sensitive information (credentials, personal data)
- [ ] I have run the diagnostic script and included the output

## πŸ’‘ Possible Solution

If you have any ideas on how to solve this issue, please describe them here.

---

**Note**: This issue will be triaged by the maintainers. Please be patient and provide additional information if requested.
139 changes: 139 additions & 0 deletions .github/ISSUE_TEMPLATE/documentation.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,139 @@
---
name: πŸ“š Documentation Issue
about: Report issues with documentation or suggest improvements
title: '[DOCS] '
labels: ['documentation', 'triage']
assignees: []

---

## πŸ“š Documentation Issue

**Type of documentation issue:**
- [ ] Missing documentation
- [ ] Outdated documentation
- [ ] Incorrect information
- [ ] Unclear/confusing content
- [ ] Documentation improvement suggestion
- [ ] New documentation request

## πŸ“ Location

**Where is the documentation issue located?**
- File/Page: [e.g., README.md, docs/USAGE.md, website page]
- Section: [e.g., Installation, Authentication, Examples]
- Line number: [if applicable]
- URL: [if web documentation]

## πŸ› Current Issue

**What is wrong with the current documentation?**
A clear description of the issue with the existing documentation.

```markdown
<!-- Quote the current problematic text here -->
Current text that needs to be fixed
```

## βœ… Suggested Fix

**What should it say instead?**
Provide your suggested improvement or correction.

```markdown
<!-- Provide the improved text here -->
Suggested replacement text
```

## πŸ“‹ Missing Information

**What information is missing?** (if applicable)
- Topic/concept that needs documentation
- Use case that needs examples
- Configuration that needs explanation
- Process that needs step-by-step guide

## 🎯 Target Audience

**Who would benefit from this documentation?**
- [ ] New users getting started
- [ ] Experienced users seeking reference
- [ ] Developers contributing to the project
- [ ] DevOps engineers implementing CI/CD
- [ ] Security teams reviewing compliance

## πŸ“– Content Suggestions

**Proposed content structure:** (for new documentation)

1. Section 1: [Title]
- Subsection 1.1
- Subsection 1.2

2. Section 2: [Title]
- Subsection 2.1
- Subsection 2.2

**Key topics to cover:**
- Topic 1
- Topic 2
- Topic 3

## πŸ’‘ Examples Needed

**What examples would be helpful?**
- [ ] Code examples
- [ ] Command-line examples
- [ ] Configuration examples
- [ ] Workflow examples
- [ ] Troubleshooting scenarios

```bash
# Example command that should be documented
rover example-command --with-options
```

## πŸ”— References

**Related resources:**
- Links to related documentation
- External resources that could help
- Similar examples from other projects

## πŸ“± Format Preferences

**Preferred documentation format:**
- [ ] Markdown file
- [ ] Code comments
- [ ] README section
- [ ] Separate guide
- [ ] Video tutorial
- [ ] Interactive examples

## 🌍 Context

**Additional context about this documentation need:**
- How did you discover this issue?
- What were you trying to accomplish?
- What documentation would have helped you?

## πŸ“‹ Checklist

Before submitting this documentation issue:

- [ ] I have searched existing issues for similar documentation requests
- [ ] I have checked if this documentation already exists elsewhere
- [ ] I have provided specific suggestions for improvement
- [ ] I have considered the target audience for this documentation

## 🀝 Contribution

**Are you willing to help with this documentation?**
- [ ] Yes, I can write the documentation
- [ ] Yes, I can review the documentation
- [ ] Yes, I can provide examples
- [ ] No, but I can provide feedback on drafts

---

**Note**: Documentation issues help improve the project for everyone. Thank you for taking the time to suggest improvements!
Loading
Loading