Skip to content

Latest commit

 

History

History
69 lines (48 loc) · 1.82 KB

CONTRIBUTING.md

File metadata and controls

69 lines (48 loc) · 1.82 KB
Raw

Contributing to auto-subs

Thank you for considering contributing to AutoSubs!
I welcome contributions from everyone. I will try to review any pull requests as soon possible 😊

Getting Started

Fork and Clone the Repository

  1. Fork the repository by clicking the "Fork" button at the top right of the repository page.
  2. Clone your forked repository to your local machine: 
    git clone https://github.com/YOUR-USERNAME/auto-subs.git
  3. Navigate to the cloned directory: 
    cd auto-subs

Create a Branch

Create a new branch for your work. Use a descriptive name for your branch (e.g., fix-bug-123 or add-new-feature):

git checkout -b my-branch-name

Install Dependencies

Ensure you have the necessary dependencies installed (guide in the readme.md)

Making Changes

  1. Make sure your changes follow the project's coding style and guidelines.
  2. Write clear and concise commit messages.
  3. Test your changes thoroughly.

Commit and Push Your Changes

  1. Add and commit your changes: 
    git add .
git commit -m "A brief description of your changes"
  2. Push your changes to your fork: 
    git push origin my-branch-name

Submitting a Pull Request

  1. Navigate to your fork on GitHub.
  2. Click the "Compare & pull request" button.
  3. Provide a clear and detailed description of your changes.
  4. Submit the pull request.

Review Process

  1. Your pull request will be reviewed by me (the repository maintainer).
  2. Ensure you address any feedback and make the necessary changes.
  3. Once your pull request is approved, it will be merged into the main branch.

Getting Help

If you need any help, feel free to open an issue on GitHub and I will try to get back to you.

Thank you for your contributions and for helping improve AutoSubs!