File tree Expand file tree Collapse file tree
Expand file tree Collapse file tree Original file line number Diff line number Diff line change 1+ # Contributing to SubPilot
2+
3+ We welcome contributions to SubPilot — subtitle editor for Android built with Jetpack Compose.
4+
5+ ## How to Contribute
6+
7+ 1 . ** Fork the repo** and create your branch from ` main `
8+ 2 . ** Write clean Kotlin code** that follows Jetpack Compose & Android style guidelines
9+ 3 . ** Test your changes** on real/emulated device
10+ 4 . ** Submit a Pull Request** with a clear description
11+
12+ ## Guidelines
13+
14+ ### Code Style
15+ - Follow Kotlin best practices
16+ - Use meaningful variable and function names
17+ - Avoid magic numbers and hardcoded strings
18+
19+ ### Commits
20+ Use clear messages:
21+ ``` bash
22+ git commit -m " fix(timeline): fix overlapping blocks on zoom"
23+ git commit -m " feat: add dual subtitle preview box"
24+ ```
25+
26+ ### Issues
27+ - Use labels like ` bug ` , ` enhancement ` , ` help wanted `
28+ - Search existing issues before opening new ones
29+
30+ ## Branch Naming
31+ ```
32+ feature/xyz-feature-name
33+ fix/xyz-bug-description
34+ ```
35+
36+ ## Contact
37+ For major contributions or suggestions, open a discussion or contact the maintainers.
Original file line number Diff line number Diff line change 1+ ---
2+ name : Bug report
3+ about : Report a problem or unexpected behavior in SubPilot
4+ title : " [Bug]: "
5+ labels : [bug]
6+ assignees : []
7+ ---
8+
9+ ### Summary
10+ Briefly describe the issue.
11+
12+ ### Steps to Reproduce
13+ 1 . Go to '...'
14+ 2 . Click on '...'
15+ 3 . See the error
16+
17+ ### Expected Behavior
18+ What should have happened?
19+
20+ ### Actual Behavior
21+ What actually happened?
22+
23+ ### Environment
24+ - Device: [ e.g. Pixel 7]
25+ - Android: [ e.g. 13]
26+ - App version: [ e.g. 1.0.0]
27+
28+ ### Screenshots
29+ _ Add if available_
30+
31+ ### Additional context
32+ Any other details...
Original file line number Diff line number Diff line change 1+ ---
2+ name : Feature request
3+ about : Suggest an idea or improvement for SubPilot
4+ title : " [Feature]: "
5+ labels : [enhancement]
6+ assignees : []
7+ ---
8+
9+ ### Is your feature request related to a problem?
10+ Please describe what the problem is.
11+
12+ ### Describe the solution you'd like
13+ What would you like to see implemented?
14+
15+ ### Alternatives you've considered
16+ Did you try anything else?
17+
18+ ### Additional context
19+ Mockups, links, or ideas...
Original file line number Diff line number Diff line change 1+ # Security Policy
2+
3+ ## Reporting a Vulnerability
4+
5+ If you discover a security vulnerability in SubPilot, please contact us directly.
6+
7+ - Email: ` docishoon@gmail.com `
8+ - GitHub: Open an issue and mark it with ` security `
9+
10+ We appreciate responsible disclosure and will work with you to address the issue promptly.
11+
12+ ## Supported Versions
13+ Currently supported:
14+
15+ | Version | Supported |
16+ | ---------| -----------|
17+ | 1.0.x | ✅ |
18+ | < 1.0 | ❌ |
19+
20+ ## Disclosure Process
21+ 1 . Submit issue or email privately
22+ 2 . Maintainers triage and investigate
23+ 3 . Patch is prepared
24+ 4 . CVE (if needed) and release published
25+
26+ Thank you for keeping SubPilot safe!
Original file line number Diff line number Diff line change 1+ name : Android Build
2+
3+ on :
4+ push :
5+ branches : [ "main" ]
6+ pull_request :
7+ branches : [ "main" ]
8+
9+ jobs :
10+ build :
11+ runs-on : ubuntu-latest
12+ steps :
13+ - uses : actions/checkout@v3
14+ - uses : actions/setup-java@v3
15+ with :
16+ distribution : ' zulu'
17+ java-version : ' 17'
18+ - name : Make gradlew executable
19+ run : chmod +x gradlew
20+ - name : Build debug APK
21+ run : ./gradlew assembleDebug
22+ - name : Upload debug APK
23+ uses : actions/upload-artifact@v4
24+ with :
25+ name : subpilot-debug-apk
26+ path : app/build/outputs/apk/debug/app-debug.apk
Original file line number Diff line number Diff line change 1+ name : Lint
2+
3+ on : [push, pull_request]
4+
5+ jobs :
6+ lint :
7+ runs-on : ubuntu-latest
8+ steps :
9+ - uses : actions/checkout@v3
10+ - uses : actions/setup-java@v3
11+ with :
12+ distribution : ' zulu'
13+ java-version : ' 17'
14+ - name : Make gradlew executable
15+ run : chmod +x gradlew
16+ - name : Run Lint
17+ run : ./gradlew lint
Original file line number Diff line number Diff line change 1+ name : Unit Tests
2+
3+ on : [push, pull_request]
4+
5+ jobs :
6+ test :
7+ runs-on : ubuntu-latest
8+ steps :
9+ - uses : actions/checkout@v3
10+ - uses : actions/setup-java@v3
11+ with :
12+ distribution : ' zulu'
13+ java-version : ' 17'
14+ - name : Make gradlew executable
15+ run : chmod +x gradlew
16+ - name : Run tests
17+ run : ./gradlew testDebugUnitTest
You can’t perform that action at this time.
0 commit comments