Hi!, thanks for reading this.
node.js V16.8.0 or above
npm V7.21.0 or above
discord.js V13.0.0 or aboverequirements guide
Create a new issue (click to expand)
If you spot a problem with the codes, search if an issue already exists. If a related issue doesn't exist, you can open a new issue using a relevant issue form. Feature request, code-enhancing and other problem can me make as issue too!
Solve an issue (click to expand)
Scan through our existing issues to find one that interests you. You can narrow down the search using labels as filters.
Make changes locally (click to expand)
-
Fork the repository.
- Using GitHub Desktop:
- Getting started with GitHub Desktop will guide you through setting up Desktop.
- Once Desktop is set up, you can use it to fork the repo!
- 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.
- GitHub Codespaces:
- Fork, edit, and preview using GitHub Codespaces without having to install and run the project locally.
- Using GitHub Desktop:
-
Check our Requirements!, your project'll problably gets error if it aint match the requirement. scroll up to see requirements guide.
-
Create a working branch and start with your changes!
Commit the changes once you are happy with them.
Our Commit Template (Optional)
to make commit looks universal can be look to our commit template, we commit by typing commit prefixes and comment after. commit should be short but understandable. if the changes is very long, more info of commit can be put in the description
| prefix | description |
|---|---|
| feat: | features added |
| fix: | bug fixed (link to issue/PR that said the bugs is appreciated) |
| edit: | file edited (we do appreciated if file edited is specified) |
| critical: | feature edited is critical to the source file ex. index.js change |
| typo: | white space fix or typo |
| delete: | file deleted |
| added: | file added |
example:
When you're finished with the changes to submit it to our source project(main), create a pull request, also known as a PR.
Pull Requesting Guide
- Fill the pre template so that we can review your PR. This template helps reviewers understand your changes as well as the purpose of your pull request.
- Don't forget to link PR to issue if you are solving one.
- Enable the checkbox to allow maintainer edits so the branch can be updated for a merge. Once you submit your PR, a Docs team member will review your proposal. We may ask questions or request for additional information.
- We may ask for changes to be made before a PR can be merged, either using suggested changes or pull request comments. You can apply suggested changes directly through the UI. You can make any other changes in your fork, then commit them to your branch.
- As you update your PR and apply changes, mark each conversation as resolved.
- If you run into any merge issues, checkout this git tutorial to help you resolve merge conflicts and other issues.
Congratulations 🎉🎉 The GitHub team thanks you ✨.
Once your PR is merged, your contributions will be publicly visible on this Github, for this repos your changes will be host on Merlion bot(Merlion#0572) at our discord server(might not update the bot too frequency).
Q & A
we accept all type of contribute(for hacktoberfest, it gotta be pull request) even if its stupid or not. BUT we wont accept spam request and toxic PR.
we are sorry we dont have that many issue to assign to all contributor rn.
but some tip to contribute is to join our discord server, see what is it about, think of what discord bot should do in here, and make new bot command out of it
you can create an issue to tell us what you are gonna do first, we'll hellp our best
Recommended Work
- create new discord bot command, bot command can be everything. not limited to moderation stuff fun stuff will do too!
- find bugs and issue, im sure theres many bugs and issue in this project but we havent found it yet.
- review our code, our code isnt perfect. we'd like if you can review and make some improvement out of it.