Contributing - JohanDevl/Export_Trakt_4_Letterboxd GitHub Wiki

Contributing to the Project

This guide explains how to contribute to the Export Trakt 4 Letterboxd project. We appreciate all contributions, whether they are bug reports, improvement suggestions, documentation, or code.

How to Contribute

Reporting a Bug

If you find a bug, please create an issue on GitHub by following these steps:

  1. First check if the bug hasn't already been reported in the existing issues
  2. Create a new issue
  3. Use a clear and descriptive title
  4. Describe in detail:
    • Steps to reproduce the bug
    • Expected behavior and observed behavior
    • Your environment (operating system, Docker version, etc.)
    • Relevant logs
  5. Add screenshots if necessary

Suggesting an Improvement

To suggest a new feature or improvement:

  1. First check if the idea hasn't already been proposed in the existing issues
  2. Create a new issue with the "enhancement" label
  3. Clearly describe the desired feature
  4. Explain why this feature would be useful for the project
  5. Propose an implementation if possible

Contributing Code

To contribute directly to the project code:

  1. Fork the repository on GitHub
  2. Clone your fork locally 
    git clone https://github.com/YOUR-USERNAME/Export_Trakt_4_Letterboxd.git
cd Export_Trakt_4_Letterboxd
  3. Create a branch for your feature or fix 
    git checkout -b your-branch-name
  4. Make your changes
  5. Test your changes
  6. Commit your changes with clear messages 
    git commit -m "Clear description of your changes"
  7. Push your branch to your fork 
    git push origin your-branch-name
  8. Create a Pull Request from your fork to the main repository

Contributing to Documentation

Documentation is just as important as code. To improve documentation:

  1. Follow the same steps as for contributing code
  2. Focus on files in the docs/ directory and the README.md
  3. Make sure your changes are clear, accurate, and helpful
  4. Create a Pull Request with your improvements

Best Practices

Code Style

  • Follow the existing code style in the project
  • Comment your code when necessary
  • Use descriptive variable and function names

Commits

  • Use clear and descriptive commit messages
  • Each commit should represent a single logical change
  • Reference issue numbers in your commit messages if applicable

Pull Requests

  • Give your Pull Request a clear title
  • Describe the changes made
  • Explain how to test your changes
  • Mention the issues your PR resolves with the keywords "Fixes #123" or "Closes #123"

Review Process

Once your Pull Request is submitted:

  1. Project maintainers will review your code
  2. Additional changes may be requested
  3. Once approved, your PR will be merged into the main branch

Testing

Before submitting a Pull Request, make sure that:

  1. Your code works as expected
  2. You have tested edge cases
  3. For Docker modifications, test that the image builds and works correctly

License

By contributing to this project, you agree that your contributions will be under the same license as the project (see the LICENSE file).

Thank you for contributing to Export Trakt 4 Letterboxd!