Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
149 lines (99 loc) · 2.77 KB

CONTRIBUTING.md

File metadata and controls

149 lines (99 loc) · 2.77 KB

Contributing

Thank You For Your Interest In Contributing To MX Player Downloader Bot. We Welcome Contributions That Improve The Project, Fix Issues, Add Features, Enhance Performance, Or Improve Documentation.

Please Read These Guidelines Before Creating Pull Requests Or Submitting Changes.

How To Contribute

1. Fork The Repository

Create Your Own Fork Of The Project Repository On GitHub.

2. Clone Your Fork

git clone https://github.com/DKBOTZPROJECT/MX-Player-Downloader-Bot.git
cd MX-Player-Downloader-Bot

3. Create A New Branch

git checkout -b feature-your-feature-name

Use Clear Branch Names Such As:

  • feature-download-improvement
  • fix-upload-bug
  • docs-readme-update

4. Make Your Changes

You Can Contribute By:

  • Fixing Bugs
  • Improving Code Quality
  • Adding New Features
  • Improving UI / Messages
  • Optimizing Performance
  • Updating Documentation
  • Refactoring Old Code

5. Test Before Submitting

Please Ensure:

  • The Bot Starts Correctly
  • Downloads Work Properly
  • Uploads Work Properly
  • No Errors In Logs
  • Existing Features Are Not Broken

6. Commit Your Changes

Use Clean And Meaningful Commit Messages.

Examples:

git commit -m "Fix Download Queue Issue"
git commit -m "Improve Upload Speed"
git commit -m "Update README File"

7. Push Your Branch

git push origin feature-your-feature-name

8. Open A Pull Request

Submit A Pull Request With:

  • Clear Title
  • Proper Description
  • What Was Changed
  • Why It Was Needed
  • Screenshots (If UI Related)

Contribution Rules

Please Follow These Rules:

  • Keep Code Clean And Readable
  • Follow Existing Project Structure
  • Avoid Unnecessary Files
  • Do Not Break Existing Features
  • Test Changes Before Submitting
  • Respect Other Contributors
  • Use Professional Language In Discussions

Reporting Bugs

If You Find A Bug, Please Open An Issue With:

  • Bug Description
  • Steps To Reproduce
  • Expected Result
  • Actual Result
  • Logs Or Error Message
  • Screenshots If Needed

Feature Requests

Want To Suggest Something New? Open An Issue And Include:

  • Feature Idea
  • Why It Is Useful
  • How It Should Work
  • Optional Example

Code Style

Recommended Practices:

  • Use Meaningful Variable Names
  • Keep Functions Organized
  • Handle Errors Properly
  • Avoid Duplicate Code
  • Write Modular Code
  • Keep Files Structured

Need Help

If You Need Help Or Want To Discuss Ideas:

Thank You

Your Support, Ideas, Fixes, And Contributions Help Improve This Project For Everyone.