Skip to content

Commit af5cd21

Browse files
committed
CONTRIBUTING and NOTICE files
Introduce CONTRIBUTING.md with guidelines for contributing, code style, and issue reporting. Add NOTICE file detailing project licensing, attributions, and third-party library acknowledgments.
1 parent 27c7772 commit af5cd21

File tree

2 files changed

+132
-0
lines changed

2 files changed

+132
-0
lines changed

CONTRIBUTING.md

Lines changed: 63 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,63 @@
1+
# Contributing to Dune (Jellyfin Android TV Client)
2+
3+
Thank you for considering contributing to Dune! We welcome all contributions that help improve this project.
4+
5+
## Code of Conduct
6+
7+
This project adheres to the [Jellyfin Code of Conduct](https://github.com/jellyfin/.github/blob/master/CODE_OF_CONDUCT.md). By participating, you are expected to uphold this code.
8+
9+
## How to Contribute
10+
11+
1. **Fork** the repository on GitHub
12+
2. **Clone** your fork locally
13+
```
14+
git clone https://github.com/your-username/DUNE.git
15+
```
16+
3. Create a new **feature branch** for your changes
17+
```
18+
git checkout -b feature/your-feature-name
19+
```
20+
4. **Commit** your changes with a clear message
21+
```
22+
git commit -m "Add your feature description"
23+
```
24+
5. **Push** to your fork
25+
```
26+
git push origin feature/your-feature-name
27+
```
28+
6. Open a **Pull Request** against the `main` branch
29+
30+
## Development Setup
31+
32+
1. Open the project in Android Studio
33+
2. Ensure you have the latest Android SDK and build tools installed
34+
3. Sync the project with Gradle files
35+
4. Build and run the project
36+
37+
## Code Style
38+
39+
- Follow the official [Kotlin Coding Conventions](https://kotlinlang.org/docs/coding-conventions.html)
40+
- Use 4 spaces for indentation
41+
- Keep lines under 120 characters
42+
- Write clear, concise commit messages
43+
- Document complex logic with comments
44+
45+
## Reporting Issues
46+
47+
When reporting bugs, please include:
48+
- Steps to reproduce the issue
49+
- Expected behavior
50+
- Actual behavior
51+
- Device/Android version information
52+
- Any relevant logs
53+
54+
## Feature Requests
55+
56+
For feature requests, please:
57+
1. Check if the feature already exists
58+
2. Explain why this feature would be valuable
59+
3. Provide any relevant design mockups or examples if applicable
60+
61+
## License
62+
63+
By contributing to this project, you agree that your contributions will be licensed under the GPL-2.0 license.

NOTICE

Lines changed: 69 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,69 @@
1+
Dune - Jellyfin Android TV Client
2+
Copyright (C) 2023-2025 Sam42a
3+
4+
This is a fork of Jellyfin for Android TV, which is free and open source software
5+
distributed under the terms of the GNU General Public License v2.0 (GPL-2.0).
6+
7+
---
8+
9+
Original Jellyfin Android TV:
10+
Copyright (C) 2017-2025 Jellyfin Contributors
11+
12+
This product includes software developed by the Jellyfin Project (https://jellyfin.org/).
13+
Original source code and NOTICE file available at:
14+
https://github.com/jellyfin/jellyfin-androidtv
15+
16+
---
17+
18+
This program is free software: you can redistribute it and/or modify
19+
it under the terms of the GNU General Public License as published by
20+
the Free Software Foundation, either version 2 of the License, or
21+
(at your option) any later version.
22+
23+
This program is distributed in the hope that it will be useful,
24+
but WITHOUT ANY WARRANTY; without even the implied warranty of
25+
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
26+
GNU General Public License for more details.
27+
28+
You should have received a copy of the GNU General Public License
29+
along with this program. If not, see <https://www.gnu.org/licenses/>.
30+
31+
---
32+
33+
Third-party libraries used in this project:
34+
35+
- Jellyfin SDK (GPL-2.0)
36+
https://github.com/jellyfin/sdk-kotlin
37+
38+
- AndroidX Libraries (Apache-2.0)
39+
https://developer.android.com/jetpack/androidx
40+
41+
- Kotlin Coroutines (Apache-2.0)
42+
https://github.com/Kotlin/kotlinx.coroutines
43+
44+
- Koin (Apache-2.0)
45+
https://insert-koin.io/
46+
47+
- Coil (Apache-2.0)
48+
https://coil-kt.github.io/coil/
49+
50+
- Markwon (Apache-2.0)
51+
https://github.com/noties/Markwon
52+
53+
- Timber (Apache-2.0)
54+
https://github.com/JakeWharton/timber
55+
56+
- ACRA (Apache-2.0)
57+
https://github.com/ACRA/acra
58+
59+
- Kotest (Apache-2.0)
60+
https://kotest.io/
61+
62+
- MockK (Apache-2.0)
63+
https://mockk.io/
64+
65+
- ExoPlayer (Apache-2.0)
66+
https://exoplayer.dev/
67+
68+
Full license texts are available in the respective library source code and in the
69+
app/src/main/assets/licenses directory.

0 commit comments

Comments
 (0)