Skip to content
This repository has been archived by the owner on Dec 1, 2023. It is now read-only.

Latest commit

 

History

History
76 lines (42 loc) · 4 KB

CONTRIBUTING.md

File metadata and controls

76 lines (42 loc) · 4 KB

Uyn logo

Contributing to this repository

This BOT is totally open-source so you can use, view the source code, make changes or even made a BOT based from this one without any limitations! But if you WANT to make any contributions into THIS repository, you should READ the contributions part below:

Getting started

Before you begin contributing to this repository, make sure you have:

Check the issues first

Before you make your changes, please check out if an issue with your changes has been exist or not.

Open your issue

If you don't find any issues exist, you can open an issue and I will review your idea or problem.

Start forking this repo!

Fork using GitHub Desktop:

Fork using the command line

  • Fork the repo so that you can make your changes without affecting the original project until you're ready to merge them.

Make changes to the files

After forking, you can make any changes to the files of this BOT as you want. I will make the Documentation part later so you can understand the code and this BOT more!

  • You need a PHP and a MySQL server/hosting if you want to run this BOT locally. express module may be required to give this BOT a server website in the future.

Open a Pull Request (PR)

When you're done making changes and you want to contribute to this repository you can open a PR here.

Submit your PR & get it reviewed

  • Once you submit your PR, I and other Uyn BOT developers will review it with you. The first thing you're going to want to do is a self review.
  • After that, we may have questions, check back on your PR to keep up with the conversation.
  • Did you have an issue, like a merge conflict? Check out our git tutorial on how to resolve merge conflicts and other issues.

Your PR is merged!

If your PR is acceptable and I have merged your PR with the current repo code, then CONGRATULATIONS! You did it!

You will be listed as a contributor and you will become a developer of the Uyn BOT.

Keep contributing

Now you're a Uyn BOT developer, you can continue making changes to the main BOT if they're acceptable! I appreciate all of your support!

Learn more about contributing to this repo

Type of contributions

You may ask, what type of contributions do I accept?

I will accept these type of contributions:

  • Making a new command, function or event for this BOT.
  • Fixed any typos or bugs existed in this BOT.
  • Fixed any "spaghetti code" that it's a better code than the one I used.

More things will be coming soon...