Skip to content

Commit 6c2c76e

Browse files
JohanDevlJohanDevl
committed
Add comprehensive documentation - Add Code of Conduct - Add Contributing guide - Add Configuration docs - Add Export Features guide - Add Installation guide - Add Trakt.tv API integration guide - Add Changelog - Update issue and PR templates
1 parent 6f74b39 commit 6c2c76e

File tree

12 files changed

+1767
-208
lines changed

12 files changed

+1767
-208
lines changed

‎.github/ISSUE_TEMPLATE/beta_feedback.md‎

Lines changed: 51 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,51 @@
1+
---
2+
name: Beta Feedback
3+
about: Provide feedback on the beta version of Export_Trakt_4_Letterboxd 2.0
4+
title: "[Beta Feedback] "
5+
labels: "beta-feedback, go"
6+
assignees: "JohanDevl"
7+
---
8+
9+
## Beta Feedback
10+
11+
Thank you for trying the beta version of Export_Trakt_4_Letterboxd 2.0!
12+
13+
### Version Information
14+
15+
- Beta version: <!-- e.g., v2.0.0-beta1 -->
16+
- Platform: <!-- e.g., Linux, macOS, Windows, Docker -->
17+
- Architecture: <!-- e.g., amd64, arm64 -->
18+
19+
### What Worked Well
20+
21+
<!-- Please describe what you liked or what worked well -->
22+
23+
### Issues Encountered
24+
25+
<!-- Please describe any issues, bugs, or unexpected behavior -->
26+
27+
### Feature Requests
28+
29+
<!-- Any features you'd like to see added or improved before the final release -->
30+
31+
### Performance
32+
33+
<!-- How does the performance compare to the previous version? -->
34+
35+
### Documentation
36+
37+
<!-- Any feedback on the documentation? Is it clear, complete, helpful? -->
38+
39+
### Installation Experience
40+
41+
<!-- Was the installation process smooth? Any issues? -->
42+
43+
### Additional Comments
44+
45+
<!-- Any other feedback not covered above -->
46+
47+
### Logs (if applicable)
48+
49+
<!-- If you encountered errors, please include relevant logs -->
50+
51+
Paste logs here or attach log files

‎.github/ISSUE_TEMPLATE/bug_report.md‎

Lines changed: 44 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -1,35 +1,57 @@
11
---
2-
name: Bug report
2+
name: Bug Report
33
about: Create a report to help us improve
4-
title: "[BUG] "
5-
labels: bug
4+
title: "[Bug] "
5+
labels: "bug"
66
assignees: ""
77
---
88

9-
**Describe the bug**
10-
A clear and concise description of what the bug is.
9+
## Bug Report
1110

12-
**To Reproduce**
13-
Steps to reproduce the behavior:
11+
### Description
1412

15-
1. Go to '...'
16-
2. Run command '....'
17-
3. See error
13+
<!-- A clear and concise description of what the bug is -->
1814

19-
**Expected behavior**
20-
A clear and concise description of what you expected to happen.
15+
### Version Information
2116

22-
**Screenshots**
23-
If applicable, add screenshots to help explain your problem.
17+
- Version: <!-- e.g., v2.0.0, v2.0.0-beta1 -->
18+
- Platform: <!-- e.g., Linux, macOS, Windows, Docker -->
19+
- Architecture: <!-- e.g., amd64, arm64 -->
2420

25-
**Environment (please complete the following information):**
21+
### Steps to Reproduce
2622

27-
- OS: [e.g. Ubuntu 20.04, macOS 12.0]
28-
- Docker version (if applicable): [e.g. 20.10.12]
29-
- Script version: [e.g. commit hash or version tag]
23+
1. <!-- First step -->
24+
2. <!-- Second step -->
25+
3. <!-- And so on... -->
3026

31-
**Logs**
32-
Please include relevant logs from the `logs` directory if applicable.
27+
### Expected Behavior
3328

34-
**Additional context**
35-
Add any other context about the problem here.
29+
<!-- A clear and concise description of what you expected to happen -->
30+
31+
### Actual Behavior
32+
33+
<!-- A clear and concise description of what actually happened -->
34+
35+
### Screenshots
36+
37+
<!-- If applicable, add screenshots to help explain your problem -->
38+
39+
### Configuration File
40+
41+
<!-- Please provide your config.toml (with sensitive information redacted) -->
42+
43+
```toml
44+
# Paste your config here
45+
```
46+
47+
### Logs
48+
49+
<!-- Please include relevant logs -->
50+
51+
```
52+
Paste logs here or attach log files
53+
```
54+
55+
### Additional Context
56+
57+
<!-- Add any other context about the problem here -->

‎.github/ISSUE_TEMPLATE/feature_request.md‎

Lines changed: 24 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -1,22 +1,33 @@
11
---
2-
name: Feature request
2+
name: Feature Request
33
about: Suggest an idea for this project
4-
title: "[FEATURE] "
5-
labels: enhancement
4+
title: "[Feature] "
5+
labels: "enhancement"
66
assignees: ""
77
---
88

9-
**Is your feature request related to a problem? Please describe.**
10-
A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
9+
## Feature Request
1110

12-
**Describe the solution you'd like**
13-
A clear and concise description of what you want to happen.
11+
### Problem Statement
1412

15-
**Describe alternatives you've considered**
16-
A clear and concise description of any alternative solutions or features you've considered.
13+
<!-- A clear and concise description of what problem you're trying to solve. E.g., I'm always frustrated when [...] -->
1714

18-
**Additional context**
19-
Add any other context or screenshots about the feature request here.
15+
### Proposed Solution
2016

21-
**Would you be willing to contribute to this feature?**
22-
Let us know if you'd be interested in helping implement this feature.
17+
<!-- A clear and concise description of what you want to happen -->
18+
19+
### Alternative Solutions
20+
21+
<!-- A clear and concise description of any alternative solutions or features you've considered -->
22+
23+
### Use Case
24+
25+
<!-- Describe a concrete use case that demonstrates the value of this feature -->
26+
27+
### Additional Context
28+
29+
<!-- Add any other context, screenshots, or examples about the feature request here -->
30+
31+
### Would you be willing to help implement this feature?
32+
33+
<!-- Let us know if you'd like to contribute to implementing this feature -->

‎.github/PULL_REQUEST_TEMPLATE.md‎

Lines changed: 26 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -1,28 +1,38 @@
1-
## Description
1+
## Pull Request Description
22

3-
Please include a summary of the change and which issue is fixed. Please also include relevant motivation and context.
3+
<!-- Describe what changes this PR introduces and why -->
44

5-
Fixes # (issue)
5+
## Related Issues
66

7-
## Type of change
7+
<!-- Link to related issues using the syntax: "Fixes #123" or "Relates to #456" -->
88

9-
Please delete options that are not relevant.
9+
## Type of Change
1010

1111
- [ ] Bug fix (non-breaking change which fixes an issue)
1212
- [ ] New feature (non-breaking change which adds functionality)
1313
- [ ] Breaking change (fix or feature that would cause existing functionality to not work as expected)
14-
- [ ] Documentation update
14+
- [ ] This change requires a documentation update
15+
- [ ] Refactoring (no functional changes)
16+
- [ ] CI/CD or build process changes
1517

16-
## How Has This Been Tested?
18+
## Checklist
1719

18-
Please describe the tests that you ran to verify your changes. Provide instructions so we can reproduce.
19-
20-
## Checklist:
21-
22-
- [ ] My code follows the style guidelines of this project
23-
- [ ] I have performed a self-review of my own code
24-
- [ ] I have commented my code, particularly in hard-to-understand areas
25-
- [ ] I have made corresponding changes to the documentation
20+
- [ ] I have read the [CONTRIBUTING](../blob/main/CONTRIBUTING.md) document
21+
- [ ] My code follows the code style of this project
22+
- [ ] I have added tests that prove my fix is effective or that my feature works
23+
- [ ] New and existing unit tests pass locally with my changes
24+
- [ ] I have updated the documentation accordingly
2625
- [ ] My changes generate no new warnings
27-
- [ ] I have tested my changes and they work as expected
2826
- [ ] Any dependent changes have been merged and published in downstream modules
27+
28+
## Screenshots (if applicable)
29+
30+
<!-- Add screenshots here if UI changes are made -->
31+
32+
## Testing Steps
33+
34+
<!-- Provide instructions so we can reproduce your testing -->
35+
36+
## Additional Information
37+
38+
<!-- Any additional information about the PR -->

‎CHANGELOG.md‎

Lines changed: 128 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,128 @@
1+
# Changelog
2+
3+
All notable changes to the Export Trakt for Letterboxd project will be documented in this file.
4+
5+
The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
6+
and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
7+
8+
## [Unreleased]
9+
10+
### Added
11+
12+
- Comprehensive test suite with unit and integration tests
13+
- Internationalization (i18n) support with English and French translations
14+
- GitHub Actions CI/CD pipeline for automated testing
15+
- Automated release workflow for cross-platform binary generation
16+
- New issue templates for bug reports, feature requests, and beta feedback
17+
- Enhanced documentation including contributing guide, installation instructions, and configuration guide
18+
19+
## [2.0.0] - TBD
20+
21+
### Added
22+
23+
- Complete rewrite in Go for improved performance and maintainability
24+
- Structured configuration using TOML format
25+
- Comprehensive logging system with support for different log levels
26+
- Advanced error handling with descriptive error messages
27+
- Internationalization (i18n) support
28+
- Multiple export formats (watched movies, watchlist, collections)
29+
- Command-line interface with various options and flags
30+
- Rate limiting for API requests to prevent exceeding Trakt.tv limits
31+
- Retry mechanism for handling transient API failures
32+
- Progress indication during exports
33+
- Enhanced movie matching using TMDb IDs
34+
- Support for advanced filtering (by rating, date range)
35+
- Better handling of rewatched movies
36+
- Cross-platform compatibility (Linux, macOS, Windows, ARM)
37+
- Docker support with multi-arch images
38+
39+
### Changed
40+
41+
- Improved configuration handling with support for environment variables
42+
- Enhanced Trakt.tv API client with better error handling
43+
- More efficient data processing for large movie collections
44+
- Better date handling with proper timezone support
45+
- Improved CSV generation with proper escaping and formatting
46+
- More reliable authentication flow with token refresh
47+
48+
### Removed
49+
50+
- Dependency on external tools (jq, curl)
51+
- Temporary file usage for data processing
52+
53+
## [1.5.0] - 2023-07-15
54+
55+
### Added
56+
57+
- Docker support with multi-arch images
58+
- GitHub Actions workflows for Docker builds
59+
- Option to include collection items in export
60+
61+
### Changed
62+
63+
- Improved error handling and reporting
64+
- Better support for special characters in movie titles
65+
- Enhanced matching algorithm for movies
66+
67+
## [1.4.0] - 2023-05-20
68+
69+
### Added
70+
71+
- Backup functionality for API responses
72+
- Support for exporting TV shows
73+
- Optional logging to file
74+
- Better date handling options
75+
76+
### Changed
77+
78+
- Improved authentication flow
79+
- Enhanced API request handling
80+
81+
## [1.3.0] - 2023-03-10
82+
83+
### Added
84+
85+
- Support for filtering by minimum rating
86+
- Option to include year in movie titles
87+
- Enhanced watchlist export
88+
89+
### Changed
90+
91+
- Improved CSV formatting
92+
- Better error messages
93+
94+
## [1.2.0] - 2023-01-25
95+
96+
### Added
97+
98+
- Export modes: normal, initial, complete
99+
- Support for watched history with dates
100+
- Automatic detection of rewatched movies
101+
102+
### Changed
103+
104+
- Improved Trakt.tv API integration
105+
- Better configuration handling
106+
107+
## [1.1.0] - 2022-11-12
108+
109+
### Added
110+
111+
- TMDB integration for better movie matching
112+
- Support for exporting ratings
113+
- Configuration file for customization
114+
115+
### Changed
116+
117+
- Enhanced authentication mechanism
118+
- Improved export format
119+
120+
## [1.0.0] - 2022-09-01
121+
122+
### Added
123+
124+
- Initial release
125+
- Basic functionality to export Trakt.tv data
126+
- Support for exporting to Letterboxd CSV format
127+
- Simple authentication with Trakt.tv API
128+
- Basic configuration options

0 commit comments

Comments
 (0)