Skip to content

Commit

Permalink
docs: added contributing guide
Browse files Browse the repository at this point in the history
  • Loading branch information
MagneticNeedle committed Jul 24, 2024
1 parent 22a47e6 commit e596a0d
Showing 1 changed file with 12 additions and 0 deletions.
12 changes: 12 additions & 0 deletions CONTRIBUTION.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
## How to add new cog to the bot?
- If the cog is a single file
- Add file in `bot/cogs` directory
- If the cog is a directory
- Create python package in `bot/cogs` directory
- In the cog's `__init__.py` file
- Import Cog class and Setup function
- Add both to `__all__` list
- In `bot/cogs/__init__.py` file
- Add the cog name to `cogs_list`
- Cog name here means the name of the file or directory
- see existing cogs for reference

0 comments on commit e596a0d

Please sign in to comment.