Skip to content

Commit 61ca9a4

Browse files
committed
Add CONTRIBUTING.md and issue templates
1 parent 0e43198 commit 61ca9a4

4 files changed

Lines changed: 116 additions & 0 deletions

File tree

Lines changed: 27 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,27 @@
1+
---
2+
name: Bug Report
3+
about: Report a bug or issue with ClearDisk
4+
title: "[Bug] "
5+
labels: bug
6+
assignees: ''
7+
---
8+
9+
**Describe the bug**
10+
A clear description of what the bug is.
11+
12+
**To Reproduce**
13+
Steps to reproduce:
14+
1. Open ClearDisk
15+
2. Click on '...'
16+
3. See error
17+
18+
**Expected behavior**
19+
What you expected to happen.
20+
21+
**Screenshots**
22+
If applicable, add screenshots.
23+
24+
**Environment:**
25+
- macOS version: [e.g. 14.2]
26+
- ClearDisk version: [e.g. 1.6.1]
27+
- Install method: [DMG / Homebrew]

.github/ISSUE_TEMPLATE/config.yml

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
blank_issues_enabled: true
2+
contact_links:
3+
- name: Questions & Help
4+
url: https://github.com/bysiber/cleardisk/discussions
5+
about: Ask questions and get help from the community
Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
1+
---
2+
name: Feature Request
3+
about: Suggest a new feature or cache type for ClearDisk
4+
title: "[Feature] "
5+
labels: enhancement
6+
assignees: ''
7+
---
8+
9+
**Is your feature request related to a problem?**
10+
A clear description of the problem. Example: "I have a lot of Gradle cache files that ClearDisk doesn't detect..."
11+
12+
**Describe the solution you'd like**
13+
What you want to happen.
14+
15+
**Cache type details (if requesting new cache support)**
16+
- Cache name: [e.g. Ruby gems]
17+
- Default location: [e.g. ~/.gem/]
18+
- Typical size: [e.g. 2-10 GB]
19+
- Safe to delete? [Yes/No/Partially]
20+
21+
**Additional context**
22+
Any other context or screenshots.

CONTRIBUTING.md

Lines changed: 62 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,62 @@
1+
# Contributing to ClearDisk
2+
3+
Thank you for your interest in contributing to ClearDisk! Every contribution helps make this tool better for developers everywhere.
4+
5+
## Ways to Contribute
6+
7+
### Report Bugs
8+
- Open an [issue](https://github.com/bysiber/cleardisk/issues/new?template=bug_report.md) with steps to reproduce
9+
- Include your macOS version and ClearDisk version
10+
11+
### Suggest Features
12+
- Open an [issue](https://github.com/bysiber/cleardisk/issues/new?template=feature_request.md) describing the feature
13+
- Explain the use case and how it would help developers
14+
15+
### Add New Cache Types
16+
ClearDisk supports 15+ cache types. If you know of a developer cache that's missing:
17+
1. Fork the repo
18+
2. Add the cache definition in the scanner module
19+
3. Submit a PR with a description of the cache type and typical size
20+
21+
### Improve Documentation
22+
- Fix typos, improve descriptions
23+
- Add translations
24+
- Improve the README
25+
26+
### Code Contributions
27+
1. Fork the repository
28+
2. Create a feature branch: `git checkout -b feature/my-feature`
29+
3. Commit your changes: `git commit -m "Add my feature"`
30+
4. Push to your fork: `git push origin feature/my-feature`
31+
5. Open a Pull Request
32+
33+
## Development Setup
34+
35+
### Requirements
36+
- macOS 14+ (Sonoma or later)
37+
- Xcode 15+
38+
- Swift 5.9+
39+
40+
### Build from Source
41+
```bash
42+
git clone https://github.com/bysiber/cleardisk.git
43+
cd cleardisk
44+
open ClearDisk.xcodeproj
45+
```
46+
47+
Build and run with Cmd+R in Xcode.
48+
49+
## Code Style
50+
- Follow Swift API Design Guidelines
51+
- Use SwiftUI for all new UI components
52+
- Keep functions small and focused
53+
- Add comments for non-obvious logic
54+
55+
## Pull Request Guidelines
56+
- Keep PRs focused on a single change
57+
- Include a clear description of what changed and why
58+
- Test on macOS 14+ before submitting
59+
- Screenshots/GIFs welcome for UI changes
60+
61+
## Questions?
62+
Open a [Discussion](https://github.com/bysiber/cleardisk/discussions) -- we're happy to help!

0 commit comments

Comments
 (0)