Skip to content

Contributing to EsTranslator

Thank you for your interest in contributing to the EsTranslator project! We welcome contributions from the community to help improve and grow the library. This document provides guidelines and information on how you can contribute effectively.

Ways to Contribute

There are several ways you can contribute to the EsTranslator project:

  1. Report Issues: If you encounter any bugs, issues, or have feature requests, please submit an issue on our GitHub repository. Include as much detail as possible to help us understand and address the problem.

  2. Provide Feedback: If you have feedback or suggestions for improving EsTranslator, we would love to hear from you. You can share your thoughts by opening a new issue or participating in discussions on existing issues.

  3. Submit Pull Requests: If you'd like to contribute code changes, bug fixes, or new features, you can submit a pull request. Follow the guidelines below to ensure a smooth review and merge process.

Development Setup

To set up a development environment for EsTranslator, follow these steps:

  1. Install Apertium:
wget https://apertium.projectjj.com/apt/install-nightly.sh -O - | sudo bash
sudo apt install apertium-all-dev
  1. Clone the repository:
git clone https://github.com/icij/es-translator.git
  1. Install the required dependencies:
cd es-translator
make install
  1. Run tests to verify the setup:
make test

Code Contribution Guidelines

When contributing code changes, please adhere to the following guidelines:

  • Fork the repository and create a new branch for your changes.
  • Ensure your code follows the existing code style and conventions.
  • Write clear and concise commit messages. We recommend using conventional commits.
  • Include tests to cover your changes and ensure they pass.
  • Update documentation as necessary.
  • Submit a pull request to the master branch of the main repository.

License

By contributing to the EsTranslator project, you agree that your contributions will be licensed under the MIT License. You retain the copyright to your contributions.

Code of Conduct

We expect all contributors to follow the Code of Conduct when contributing to EsTranslator.