Skip to content

Latest commit

 

History

History
122 lines (79 loc) · 3.97 KB

CONTRIBUTING.md

File metadata and controls

122 lines (79 loc) · 3.97 KB

Contributing to PythonBrokenEnglish

Welcome to the PythonBrokenEnglish Project! We appreciate your interest in contributing. Whether you're improving audio resources, scripts, videos, or fixing bugs, your contributions make a difference.

Follow this guide to get started with contributing to the project.

Table of Contents

  1. How to Contribute
  2. Setting Up the Development Environment
  3. Submitting Issues
  4. Code Contribution Guidelines
  5. Pull Request Process
  6. Code of Conduct

How to Contribute

Contributions can be:

  • Adding audio or video resources in different languages.
  • Creating or improving example scripts.
  • Improving documentation.
  • Fixing bugs or adding new features.

Start by forking the repository and following the steps below.

Setting Up the Development Environment

  1. Fork the Repository:
    Navigate to the project on GitHub and click the "Fork" button to create a copy under your GitHub account.

  2. Clone the Fork:
    Clone the forked repository to your local machine:

    git clone https://github.com/YOUR_USERNAME/PythonBrokenEnglish.git
cd PythonBrokenEnglish

  3. Explore the Directory:
    The project is organized into directories such as audios, scripts, videos, etc. Explore the content and understand the structure.

  4. Create a Branch:
    For new changes, always create a new branch from main or master:

    git checkout -b feature/your-feature-name

Submitting Issues

  1. Check for Existing Issues:
    Before submitting a new issue, check the Issues section to avoid duplicates.

  2. Create a New Issue:
    Click the "New Issue" button and describe the problem or feature request clearly. Be as specific as possible, and include relevant screenshots or code snippets if necessary.

  3. Label the Issue:
    Add appropriate labels, such as bug, enhancement, question, etc., to make it easier for others to identify.

Code Contribution Guidelines

  1. Follow the Project's Code Style:
    Use clear and concise code, and follow any coding style guidelines provided in the project.

  2. Write Meaningful Commit Messages:
    Summarize the purpose of your commit in a clear message. Example:

    git commit -m "Fix typo in Hausa audio description"

  3. Add or Update Documentation:
    If you add a new feature or fix something significant, update the relevant documentation (README.md, etc.).

  4. Test Your Changes:
    Before submitting, make sure your changes don't break anything. Test your additions, especially if you modified example scripts.

Pull Request Process

  1. Ensure Your Branch is Up-to-Date:
    Sync your local branch with the main repository to avoid conflicts:

    git pull origin main

  2. Submit a Pull Request (PR):
    Push your branch to your forked repository and submit a PR to the main branch of the project:

    git push origin feature/your-feature-name

  3. Create the Pull Request on GitHub:
    Go to the original repository and click "Pull Request". Choose your branch and provide a detailed explanation of your changes.

  4. Address Feedback:
    If reviewers provide feedback, make changes accordingly and update your PR.

Code of Conduct

Please adhere to the Code of Conduct. We aim to create a welcoming and inclusive environment for everyone.

Thank You!

Thank you for your contributions to PythonBrokenEnglish! Your efforts help learners across different languages and cultures access quality educational content. Let’s work together to build a rich and accessible language learning resource!