Contributing to Multilingual Translation Model Trainer

First off, thank you for considering contributing to the Multilingual Translation Model Trainer! It's people like you that make this project such a great tool.

Table of Contents

1. Code of Conduct
2. Getting Started
3. How Can I Contribute?
4. Style Guidelines
5. Commit Messages
6. Pull Requests

Code of Conduct

This project and everyone participating in it is governed by our Code of Conduct. By participating, you are expected to uphold this code. Please report unacceptable behavior to [project_email@example.com].

Getting Started

• Make sure you have a GitHub account
• Fork the repository on GitHub
• Clone your fork locally
• Set up the development environment as described in the README.md

How Can I Contribute?

Reporting Bugs

• Ensure the bug was not already reported by searching on GitHub under Issues
• If you're unable to find an open issue addressing the problem, open a new one

Suggesting Enhancements

• Open a new issue with a clear title and detailed description
• Provide specific examples to demonstrate the steps

Your First Code Contribution

• Look for issues labeled "good first issue" or "help wanted"
• If you're new to the project, these are great places to start!

Pull Requests

1. Fork the repo and create your branch from main
2. If you've added code that should be tested, add tests
3. Ensure the test suite passes
4. Make sure your code lints
5. Issue that pull request!

Style Guidelines

Python Style Guide

This project follows the PEP 8 style guide for Python code. Additionally:

• Use 4 spaces for indentation
• Use docstrings for all public classes, methods, and functions
• Keep line length to a maximum of 120 characters

Documentation Style Guide

• Use Markdown for documentation
• Keep language clear and concise
• Provide examples where applicable

Commit Messages

• Use the present tense ("Add feature" not "Added feature")
• Use the imperative mood ("Move cursor to..." not "Moves cursor to...")
• Limit the first line to 72 characters or less
• Reference issues and pull requests liberally after the first line

Pull Requests

1. Ensure any install or build dependencies are removed before the end of the layer when doing a build
2. Update the README.md with details of changes to the interface, this includes new environment variables, exposed ports, useful file locations, and container parameters
3. Increase the version numbers in any examples files and the README.md to the new version that this Pull Request would represent
4. You may merge the Pull Request in once you have the sign-off of two other developers, or if you do not have permission to do that, you may request the second reviewer to merge it for you

Thank you for your contributions!