Skip to content
This repository was archived by the owner on May 11, 2026. It is now read-only.

Commit ad9ec27

Browse files
committed
add ISSUE_TEMPLATEs
1 parent c036265 commit ad9ec27

5 files changed

Lines changed: 133 additions & 1 deletion

File tree

Lines changed: 37 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,37 @@
1+
---
2+
name: 🐛 Bug Report
3+
about: Create a report to help us improve
4+
title: "[BUG] "
5+
labels: bug
6+
assignees: ''
7+
---
8+
9+
**Describe the bug**
10+
A clear and concise description of what the bug is.
11+
12+
**🕹️ Game Information**
13+
* **Game Name:**
14+
* **AppID (if known):**
15+
* **Was `--unpack` used?** [Yes/No]
16+
17+
**💻 System Information**
18+
* **OS:** Windows [e.g. 10/11]
19+
* **Python Version:** [e.g. 3.13]
20+
* **`steamlayer` Version:** [e.g. 0.1.5]
21+
22+
**🏃 To Reproduce**
23+
Steps to reproduce the behavior:
24+
1. Run command '...'
25+
2. See error '...'
26+
27+
**📄 Logs**
28+
Please provide the output of the command run with `-vv` (debug mode):
29+
<details>
30+
<summary>Click to expand logs</summary>
31+
32+
```text
33+
INSERT LOGS HERE
34+
```
35+
</details>
36+
37+
**💡 Additional context**: Add any other context about the problem here (e.g. screenshots of the game folder).

.github/ISSUE_TEMPLATE/custom.md

Lines changed: 31 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,31 @@
1+
---
2+
name: 📝 General Issue
3+
about: Report a bug, ask a question, or suggest an improvement.
4+
title: "[Issue] <Short description of the issue>"
5+
labels: ''
6+
assignees: ''
7+
---
8+
9+
## **🔍 Issue Description**
10+
Provide a clear and concise description of the issue.
11+
12+
## **📌 Steps to Reproduce**
13+
1. Go to '...'
14+
2. Click on '...'
15+
3. See the error or unexpected behavior.
16+
17+
## **💡 Expected Behavior**
18+
Describe what you expected to happen.
19+
20+
## **🖥️ Environment Details**
21+
| **Component** | **Version** |
22+
|--------------|------------|
23+
| OS | [e.g. Ubuntu 22.04] |
24+
| Kubernetes Version | [e.g. 1.26] |
25+
| Helm Version | [e.g. 3.11.0] |
26+
27+
## **📸 Screenshots & Logs**
28+
If applicable, add screenshots or logs to help explain the problem.
29+
30+
## **📎 Additional Context**
31+
Add any other context about the issue, such as related PRs, issues, or workarounds you've tried.
Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
---
2+
name: 🚀 Feature Request
3+
about: Suggest an idea to improve Kube-NetLag
4+
title: "[Feature] <Short description of the feature>"
5+
labels: enhancement
6+
assignees: ''
7+
---
8+
9+
## **🚀 Is your feature request related to a problem? Please describe.**
10+
A clear and concise description of what the problem is.
11+
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 relevant context, screenshots, or references to related issues.

CONTRIBUTING.md

Lines changed: 45 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,45 @@
1+
# Contributing to steamlayer 🛠️
2+
3+
First off, thanks for taking the time to contribute! It's people like you that make `steamlayer` better for everyone.
4+
5+
## 🚀 Getting Started
6+
This project uses [uv](https://github.com/astral-sh/uv) for dependency management and tooling.
7+
8+
1. **Fork the repository** on GitHub.
9+
2. **Clone your fork** locally:
10+
```bash
11+
git clone https://github.com/YOUR_USERNAME/steamlayer.git
12+
cd steamlayer
13+
```
14+
15+
3. **Setup the enviroment:**
16+
```bash
17+
uv sync --all-groups
18+
```
19+
20+
## ✅ Code Quality Standards
21+
We maintain high standards to keep the project resilient. Before submitting a PR, please ensure your code passes these checks:
22+
- Linting & Formating: we use [ruff](https://github.com/astral-sh/ruff).
23+
```bash
24+
uv run ruff check .
25+
uv run ruff format .
26+
```
27+
28+
- Type Checking: we use [mypy](https://github.com/python/mypy).
29+
```bash
30+
uv run mypy steamlayer --explicit-package-base --ignore-missing-imports
31+
```
32+
33+
- Testing: We use [pytest](https://github.com/pytest-dev/pytest).
34+
```bash
35+
uv run pytest
36+
```
37+
38+
## 📬 Pull Request Process
39+
1. Create a new branch for your feature or bugfix: `git checkout -b feat/cool-new-thing.`
40+
2. Commit your changes with descriptive messages.
41+
3. Push to your fork and submit a Pull Request.
42+
4. Ensure the CI pipeline passes on your PR.
43+
44+
## ⚖️ License
45+
By contributing, you agree that your contributions will be licensed under the project's MIT License.

steamlayer/discovery/resolver.py

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -152,7 +152,6 @@ def resolve(
152152
log.warning("AppID discovery failed. Network is disabled.")
153153
return DiscoveryResult(source=DiscoverySource.NONE)
154154

155-
log.info(f"Searching Steam for: '{original_name}'...")
156155
with spinner(f"Searching steam for {original_name}..."):
157156
queries = self.query_strategy.generate(original_name)
158157
for query in queries:

0 commit comments

Comments
 (0)