Skip to content

Latest commit

 

History

History
113 lines (81 loc) · 3.18 KB

CONTRIBUTING.md

File metadata and controls

113 lines (81 loc) · 3.18 KB
Raw

Contributing

NOTE: We're planning to migrate the codebase to the pumpkin.py project. All the functions from this bot will be moved there.

Repository setup

  • Fork the repository
  • Clone your fork: git clone [email protected]/<your-nickname>/rubbergoddess.git
  • cd rubbergoddess
  • Add upstream: git remote add upstream [email protected]:sinus-x/rubbergoddess.git
  • Create your feature branch: git checkout devel && git branch my-feature && git checkout my-feature
  • Open your pull requests from this branch

When the upstream devel branch gets updated, you can sync it with yours by running

git fetch upstream
git merge upstream/master master
git merge upstream/devel devel

If you commit directly to the devel branch, you will encounter merge issues you'll have to resolve yourself. So, don't do that and create your feature branch, it only takes two seconds.

Bot setup

# Download, create and enable venv environment
sudo apt install python3-venv
python3 -m pip install venv
python3 -m venv .venv
source .venv/bin/activate

# Install bot packages
python3 -m pip install -r requirements.txt
python3 -m pip install -r requirements-dev.txt

# Enable pre-commit
pre-commit install

Packages

When fetching data online, prefer aiohttp over requests (yes, the code uses it from legacy reasons, but it shouldn't be added).

If you use Sublime Text, install the package requirementstxt and set syntax of requirements.txt. You can press Alt+, to update package version pins. If the major version changes, revert the settings OR make sure ALL functionality the bot uses is still working.

Cog organisation

Each module has its directory in cogs/, inside of it there is __init__.py file and file with the same name as its directory:

from .test import Test

def setup(bot):
	"""Load test cog"""
	bot.add_cog(Test(bot))

The module itself is usually single class. Please follow this import ordering:

# general
import base64
import random

# discord.py
import discord
from discord.ext import commands

# bot
from cogs.resource import CogConfig, CogText
from core import acl, rubbercog, utils

The class has four parts: init, commands, logic, helper functions and error catching. Not all parts have to be present.

class Test(rubbercog.Rubbercog):
	"""Test cog"""

	def __init__(self, bot):
		super().__init__(bot)

		self.config = CogConfig("test")
		self.text = CogText("test")

		# additional setup

	##
	## Commands
	##

	@commands.check(acl.check)
	@commands.group(name="foo")
	async def foo(self, ctx):
		"""Command group"""
		await utils.send_help(ctx)

	@commands.check(acl.check)
	@foo.command()
	async def foo_bar(self, ctx):
		"""Do bar"""
		await ctx.send("Functinality.")

	##
	## Logic
	##

	def fill_embed(self, ctx: commands.Context) -> discord.Embed:
		pass

If the bot's reply is an embed, the original message should be deleted (because there is author reference in the footer), unless there is a reason not to do so. If the reply is regular message and the trigger message is not being removed, it should be a reply -- mentioning one, unles there's reason not to.