Skip to content

Latest commit

 

History

History
34 lines (22 loc) · 2.46 KB

CONTRIBUTING.md

File metadata and controls

34 lines (22 loc) · 2.46 KB

Contributing to LoanPy

Thank you for considering contributing to loanpy! This software was developed for the PhD project "Gothic loanwords in Hungarian" at the University of Vienna. Built on the CLDF standards, loanpy has no dependencies and can be used to train, evaluate, and apply predictive models for horizontal (borrowing) or vertical (historical) lexical transfers. It also allows for searching (old) loanwords between two unrelated languages, providing insights into the (ancient) history of languages and the people who spoke them.

How to Contribute

To contribute to this project, follow these steps:

  1. Familiarise yourself with the project by reading the docs.
  2. Learn the basics of Cross Linguistic Data Formats.
  3. Explore these three input respositories: ronataswestoldturkic, gerstnerhungarian, and koeblergothic. Pay special attention to their documentation by clicking on the "docs"-badge.
  4. Examine the repository containing the final results of the analysis: GothicHungarian
  5. Review the contribution guidelines detailed in this document.
  6. Open an issue or contact me.

Contribution Guidelines

When contributing to this project, please adhere to the following guidelines:

  1. Use clear and concise commit messages to describe your changes.
  2. Create a separate branch for your changes, and ensure that it is up to date with the main branch.
  3. Maintain a consistent and well-organised project structure.
  4. Update the test files and ensure that tests pass before submitting a contribution.
  5. Include docstrings and inline-comments in your Python scripts, following established conventions.
  6. Update the documentation to reflect your changes, if necessary.
  7. Submit a pull request for review, providing a detailed description of your changes and any relevant context.

By following these guidelines, you help maintain high-quality software and make it easier for others to use and contribute to the project.

Communication

If you have any questions or need assistance, please don't hesitate to contact me via e-mail or Twitter. I appreciate your interest and look forward to collaborating with you!