Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

STEPS FOR CONTRIBUTION #29

Open
tintinkung opened this issue Oct 12, 2021 · 2 comments
Open

STEPS FOR CONTRIBUTION #29

tintinkung opened this issue Oct 12, 2021 · 2 comments
Labels
application documentation Improvements or additions to documentation Hacktoberfest Hacktoberfest stuff

Comments

@tintinkung
Copy link
Member

tintinkung commented Oct 12, 2021

STEPS FOR CONTRIBUTION

see readme for project understanding

  1. See what you want to contribute. want to fix bugs in code? want to add a cool new feature? and create a new issue telling what you want to do here

  2. Fork this repository and you'll have this repo in your own GitHub but duplicated

  3. Clone the code to your local desktop (either by github desktop or manual clone)

  4. Do edit and add anything you want
    3.1 for this repos only, you'll need to create your discord bot to test out the code. (to create add new bot at discord devs portal)
    3.2 run npm ci, then npm start. to initialize project
    3.3 see the code at project/data/auth.example.json, create a copy of it with the name auth.json. paste your bot token in there
    3.4 invite the bot to your private discord server or whatever
    3.5 run the bot (by node . in the console)
    3.6 now you can try out your bot's code and do any edit you want!

  5. After you are fine with the edit you do, create a pull request and compare it to the main with your forked repository here.
    4.1 PLEASE check all you typo and code error before creating a pull request

  6. Wait for us to review your code and accept your pull request!

    6. pls star this repo :> 🌟


Disclaimer

  • accepted pull request will be host at bte ASEAN discord though Merlion bot (Merlion#0572)
  • this project is a work in progress and may not has a clean beautiful code yall would expect
  • do not delete this post.

REQUIREMENTS

node.js v16.8.0 or above
npm v7.21.0 or above
discord.js v13 or obove

merlionVersion

for node.js check by nodejs -v / node -v
for discord.js check by npm list discord.js
to download node v16 go here

if your node is up to date now, update discord.js
to install discord.js v13

@tintinkung tintinkung pinned this issue Oct 12, 2021
@tintinkung tintinkung added documentation Improvements or additions to documentation Hacktoberfest Hacktoberfest stuff labels Oct 12, 2021
@ASEAN-Build-The-Earth ASEAN-Build-The-Earth locked and limited conversation to collaborators Oct 13, 2021
@StoneMcYT
Copy link
Contributor

Also if you have questions you can create a Q&A page

Screencast.from.10-13-2021.08.51.18.AM.mp4

@StoneMcYT
Copy link
Contributor

By the way if you're currently planning to do something that has been scheduled on our todo list https://github.com/ASEAN-Build-The-Earth/Merlion/projects/1
Reply to the issue saying you are gonna do it so we can assign it.

Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
application documentation Improvements or additions to documentation Hacktoberfest Hacktoberfest stuff
Projects
None yet
Development

No branches or pull requests

2 participants