Skip to content

Latest commit

 

History

History
69 lines (46 loc) · 2.93 KB

CONTRIBUTING.md

File metadata and controls

69 lines (46 loc) · 2.93 KB
Raw

Contributing

First off, thank you for considering contributing to our discord bot!

Table of Contents

Code of Conduct

Please follow the Code of Conduct while contributing to this project. Report any violations to [email protected].

Questions, Bugs, Features

I have a question regarding the bot

Please do not open an issue to ask a question. Contact us on discord or send us an email.

I found a bug in the bot

If you found a bug in the code, open an issue or submit a pull request.

I would like a new feature

You can open an issue or contact us on discord for feature requests.

How can I contribute?

You can refer to this guide on creating a PR.

Setting up the dev environment

  • Fork the repository
  • Clone the forked repo locally - git clone https:/{user}/discord-bot.git
  • Make a new branch as we don't want to mess with the main (master) branch - git checkout -b {newBranchName}

    The name of the new branch can be anything, just make sure it isn't the same as an existing branch.

Committing the changes

  • After making the changes, add the changed files by running git add .

    Make sure you do not commit the install or build dependencies (node_modules/), the .env file or an updated config.json file. By default, the node_modules and .env are ignored by git but please be sure before committing.

  • Commit the files using git commit -m "the commit message here".

Note: The versioning scheme we use is SemVer.

Pushing the changes

  • After committing the changes, push the commits to the forked repo - git push -u origin {branchName}.

    Make sure the origin is the forked repo. This can be verified by running git remote.

License

This project is licensed under the MIT license.