Skip to content

Latest commit

 

History

History
43 lines (25 loc) · 2.64 KB

CONTRIBUTING.md

File metadata and controls

43 lines (25 loc) · 2.64 KB
Raw

Contributing to Synthalingua

Introduction

We appreciate your interest in contributing to Synthalingua! Our project thrives on the support and contributions of the open-source community. Here are some guidelines to help you get started with contributing to our project.

Contribution Guidelines

Code Contributions

  1. No AI-Generated Code: We value human creativity and ingenuity in our project. Therefore, we do not accept pull requests (PRs) that contain code generated by AI tools like ChatGPT or other coding AI programs. We seek unique, human-crafted code contributions.

  2. Research and Testing: Your contributions should be well-researched and tested to ensure compatibility with the minimum specifications for Python outlined in our project requirements.

  3. Documentation: If you add new features or make changes to existing ones, please update the documentation accordingly.

  4. Code Style: Please adhere to the coding style and conventions used in the project. This helps in maintaining readability and consistency in the codebase.

Reporting Issues

  1. Detailed Reports: When reporting issues, be as detailed as possible. Include steps to reproduce the issue, expected outcomes, and actual outcomes.

  2. Screenshots and Logs: If applicable, add screenshots and relevant log files to help us understand and address the issue more efficiently.

  3. Search Existing Issues: Before creating a new issue, please check if it has already been reported or fixed. Duplicate issues clutter the issue tracker and slow down response times.

Pull Requests

  1. Descriptive Titles: Use descriptive titles for your pull requests. It should briefly explain the changes or additions.

  2. Description: In the PR description, provide a detailed explanation of what changes have been made and why. Link any relevant issues.

  3. Small, Focused Changes: Keep your PRs small and focused on a single feature or bug fix. This makes the review process faster and more effective.

  4. Testing: Before submitting a PR, ensure your changes do not break existing functionality. Test your changes thoroughly.

Community Conduct

  1. Respectful Communication: Always communicate respectfully with other contributors and maintainers.

  2. Collaboration: Be open to collaboration and constructive feedback.

  3. Inclusivity: We are committed to creating an inclusive environment where everyone feels welcome to contribute.

Getting Started

To get started, fork the repository, make your changes in a new branch, and then submit a pull request for review.

Thank you for contributing to Synthalingua, and we look forward to your valuable contributions!