Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
106 lines (76 loc) · 3.22 KB

CONTRIBUTING.md

File metadata and controls

106 lines (76 loc) · 3.22 KB

Contributing to RumAI

Thank you for considering contributing to RumAI! We welcome contributions from everyone and appreciate your time and effort in helping us improve this project.

Table of Contents

  1. Getting Started
  2. Ways to Contribute
  3. Development Guidelines
  4. Submitting Changes
  5. Code of Conduct
  6. Where to Get Help

Getting Started

To get started with contributing, follow these steps:

  1. Fork the Repository: Click the "Fork" button at the top-right corner of the repository page.
  2. Clone Your Fork: 
    git clone https://github.com/your-username/rumai.git
cd rumai
  3. Set Up Your Environment:
    • Follow the instructions in the README.md file to set up the development environment.
  4. Create a Branch: 
    git checkout -b feature/your-feature-name

Ways to Contribute

There are many ways you can contribute to RumAI:

  1. Report Bugs: Open an issue describing the bug and how to reproduce it.
  2. Suggest Features: Share your ideas for new features or improvements by creating an issue.
  3. Fix Issues: Check the Issues section for tasks labeled help wanted or good first issue.
  4. Improve Documentation: Enhance the documentation in README.md, docs/, or other parts of the project.
  5. Write Tests: Add or improve test cases for existing features.
  6. Contribute Code: Implement new features, fix bugs, or refactor existing code.

Development Guidelines

To ensure consistency and maintainability, please follow these guidelines:

  • Code Style:
    • Use clear and concise code.
    • Follow PEP8 for Python and standard practices for JavaScript/TypeScript.
  • Commit Messages:
    • Use present tense (e.g., "Add feature" instead of "Added feature").
    • Keep the first line under 50 characters and provide additional details if necessary.
  • Testing:
    • Ensure all tests pass before submitting your changes.
    • Add tests for new features or bug fixes.

Submitting Changes

  1. Commit Your Changes: 
    git add .
git commit -m "Brief description of changes"
  2. Push to Your Fork: 
    git push origin feature/your-feature-name
  3. Open a Pull Request (PR):
    • Go to your fork on GitHub and click "Compare & Pull Request."
    • Provide a detailed description of your changes in the PR.

PR Review Process

  • All pull requests will be reviewed by maintainers.
  • If changes are requested, please address them promptly.
  • Once approved, your PR will be merged into the main branch.

Code of Conduct

We are committed to fostering an open and welcoming environment for all contributors. Please read our Code of Conduct before participating in this project.

Where to Get Help

If you have questions or need assistance:

Thank you for contributing to RumAI! Your support helps us build a better platform for learning Russian with AI.