Skip to content

Commit 3473afd

Browse files
SopwitSopwit
committed
Add security reporting link to issue template and update documentation
- Added a link for reporting security vulnerabilities in the issue template. - Removed obsolete screenshot section from the application metadata. - Updated tests to ensure no screenshots are referenced. - Created new issue and pull request templates for better contribution guidelines. - Added a Code of Conduct and Contributing guidelines to enhance community standards. - Introduced a README and SECURITY policy for clearer project information and security practices.
1 parent 9046ba9 commit 3473afd

11 files changed

Lines changed: 198 additions & 31 deletions

‎.github/ISSUE_TEMPLATE/bug_report.md‎

Lines changed: 31 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,31 @@
1+
---
2+
name: Bug report
3+
about: Report a defect or regression
4+
title: "[BUG] "
5+
labels: bug
6+
assignees: ''
7+
---
8+
9+
## Summary
10+
11+
Describe the bug clearly.
12+
13+
## Reproduction
14+
15+
1.
16+
2.
17+
3.
18+
19+
## Expected result
20+
21+
## Actual result
22+
23+
## Environment
24+
25+
- Distribution:
26+
- Desktop session:
27+
- GPU:
28+
- Driver version:
29+
- ro-Control version:
30+
31+
## Logs or screenshots

‎.github/ISSUE_TEMPLATE/config.yml‎

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3,3 +3,6 @@ contact_links:
33
- name: Questions and general support
44
url: https://github.com/Project-Ro-ASD/ro-Control/discussions
55
about: Ask questions and get usage help in Discussions.
6+
- name: Security vulnerability reporting
7+
url: https://github.com/Project-Ro-ASD/ro-Control/security/policy
8+
about: Report security issues privately when possible.

‎.github/ISSUE_TEMPLATE/feature_request.md‎

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
---
2+
name: Feature request
3+
about: Suggest a product or workflow improvement
4+
title: "[FEAT] "
5+
labels: enhancement
6+
assignees: ''
7+
---
8+
9+
## Problem
10+
11+
## Proposed change
12+
13+
## Alternatives considered
14+
15+
## Additional context

‎.github/PULL_REQUEST_TEMPLATE.md‎

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
## Summary
2+
3+
## What Changed
4+
5+
-
6+
7+
## Validation
8+
9+
- [ ] Build passed
10+
- [ ] Tests passed
11+
- [ ] UI checked if applicable
12+
- [ ] Translations updated if applicable
13+
14+
## Notes

‎CODE_OF_CONDUCT.md‎

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
# Code of Conduct
2+
3+
Contributors are expected to keep discussions technical, respectful, and concise.
4+
5+
Unacceptable behavior includes:
6+
7+
- harassment or personal attacks
8+
- spam or intentionally disruptive behavior
9+
- publishing private security details irresponsibly
10+
11+
Project maintainers may moderate discussions, close threads, or restrict participation when needed to keep collaboration functional.

‎CONTRIBUTING.md‎

Lines changed: 42 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,42 @@
1+
# Contributing to ro-Control
2+
3+
## Workflow
4+
5+
- branch from `main`
6+
- keep changes focused
7+
- open a pull request back to `main`
8+
- avoid direct pushes to `main`
9+
10+
Recommended branch prefixes:
11+
12+
- `feat/`
13+
- `fix/`
14+
- `docs/`
15+
- `chore/`
16+
17+
## Before Opening a PR
18+
19+
- build the project successfully
20+
- run tests
21+
- update translations if user-facing strings changed
22+
- include screenshots for visible UI changes when relevant
23+
24+
Suggested commands:
25+
26+
```bash
27+
cmake -S . -B build -DCMAKE_BUILD_TYPE=Release -DBUILD_TESTS=ON
28+
cmake --build build --parallel
29+
ctest --test-dir build --output-on-failure
30+
```
31+
32+
## Style
33+
34+
- keep English as the source language in code
35+
- use `qsTr(...)` in QML and `tr(...)` in C++
36+
- prefer small, reviewable pull requests
37+
38+
## Issues
39+
40+
- use bug reports for defects
41+
- use feature requests for product changes
42+
- keep reproduction steps concrete

‎README.md‎

Lines changed: 62 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,62 @@
1+
# ro-Control
2+
3+
Native Qt6/QML desktop application for NVIDIA driver management and Linux system monitoring.
4+
5+
## Overview
6+
7+
ro-Control focuses on three things:
8+
9+
- installing, updating, and cleaning NVIDIA drivers on Fedora-oriented Linux systems
10+
- monitoring CPU, GPU, and RAM telemetry in a native desktop UI
11+
- exposing a small CLI for diagnostics and scripted driver operations
12+
13+
The application ships runtime translations for:
14+
15+
- English
16+
- German
17+
- Spanish
18+
- Turkish
19+
20+
## Features
21+
22+
- Driver install, update, deep-clean, and rescan workflows
23+
- Secure Boot detection and related driver warnings
24+
- CPU, GPU, and RAM telemetry dashboard
25+
- Qt-based localization and persistent UI preferences
26+
- CLI commands for status, diagnostics, and driver actions
27+
28+
## Build
29+
30+
Quick local build:
31+
32+
```bash
33+
cmake -S . -B build -DCMAKE_BUILD_TYPE=Release -DBUILD_TESTS=ON
34+
cmake --build build --parallel
35+
ctest --test-dir build --output-on-failure
36+
```
37+
38+
## Packaging
39+
40+
The repository includes:
41+
42+
- desktop entry metadata
43+
- AppStream metadata
44+
- PolicyKit policy
45+
- shell completions
46+
- RPM packaging files
47+
48+
## Contributing
49+
50+
Use short-lived branches from `main` and open pull requests back to `main`.
51+
52+
See [CONTRIBUTING.md](CONTRIBUTING.md).
53+
54+
## Security
55+
56+
Report vulnerabilities privately when possible.
57+
58+
See [SECURITY.md](SECURITY.md).
59+
60+
## License
61+
62+
GPL-3.0-or-later. See [LICENSE](LICENSE).

‎SECURITY.md‎

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
# Security Policy
2+
3+
If you discover a security issue, do not open a public bug report first.
4+
5+
Preferred path:
6+
7+
- use GitHub Security Advisories for private reporting
8+
9+
If private reporting is not available, open a minimal issue without exploit details and request a private contact path.
10+
11+
## Scope
12+
13+
Security-sensitive areas include:
14+
15+
- privileged helper execution
16+
- PolicyKit integration
17+
- driver installation and removal flows
18+
- command execution paths
19+
- package and metadata distribution integrity

‎data/icons/io.github.projectroasd.rocontrol.metainfo.xml‎

Lines changed: 0 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -42,12 +42,6 @@
4242
<release version="0.2.1" date="2026-03-30" />
4343
</releases>
4444

45-
<screenshots>
46-
<screenshot type="default">
47-
<image>https://raw.githubusercontent.com/Project-Ro-ASD/ro-Control/main/docs/screenshots/monitor-overview.svg</image>
48-
</screenshot>
49-
</screenshots>
50-
5145
<launchable type="desktop-id">io.github.projectroasd.rocontrol.desktop</launchable>
5246
<provides>
5347
<binary>ro-control</binary>
@@ -60,5 +54,4 @@
6054
<url type="homepage">https://github.com/Project-Ro-ASD/ro-Control</url>
6155
<url type="vcs-browser">https://github.com/Project-Ro-ASD/ro-Control</url>
6256
<url type="bugtracker">https://github.com/Project-Ro-ASD/ro-Control/issues</url>
63-
<url type="help">https://github.com/Project-Ro-ASD/ro-Control/blob/main/SUPPORT.md</url>
6457
</component>

‎docs/screenshots/monitor-overview.svg‎

Lines changed: 0 additions & 20 deletions
This file was deleted.

0 commit comments

Comments
 (0)