Merge pull request #269 from SylteA/dev

merge from dev

CONTRIBUTING.md

@@ -0,0 +1,70 @@
+# Contributing
+
+## Setup Discord Application
+
+Refer to the official discord.py [documentation](https://discordpy.readthedocs.io/en/stable/discord.html) to create a bot.
+
+Also, please make sure that the scope application.commands is enabled.
+
+Make sure to enable intents as well—check the official guide for detailed instructions [here](https://discordpy.readthedocs.io/en/latest/intents.html).
+
+<img width="1313" alt="Screenshot 2023-11-14 at 12 51 00 PM" src="https://github.com/sarzz2/Discord-Bot/assets/45039724/97fd0d7f-8e6b-4d7b-b4f9-008a07dfb26b">
+
+
+
+## Project Setup & Installation
+
+1. Fork the repository to your own profile.
+2. Set up a local PostgreSQL database or use [Docker](#Docker-Setup).
+
+   ```postgresql://username:password@localhost/db_name```
+
+   Replace username, password, db_name with appropriate values.
+
+3. To install packages, run:
+
+   ```bash
+   pip install poetry
+   poetry install
+   ```
+4. Once all the packages are installed, run migrations using:
+
+   ```python cli.py migrate up```
+
+5. Create a .env file and copy the contents of example.env, setting up the environment variables.
+
+6. Once the above steps are done, run the bot using the command:
+
+   ```bash
+   python cli.py
+   ```
+
+7. Feel free to join the server in case of any issues.
+
+## Docker-Setup
+
+1. Ensure you have Docker installed and set up on your system. Refer to the [Docker's official guide](https://docs.docker.com/get-started/overview/) if needed.
+2. To run a PostgreSQL instance, execute:
+
+   ```bash
+   docker compose up -d postgres
+   ```
+   The `-d` flag runs the instance in detached mode.
+
+3. Run migrations.
+
+   ```python cli.py migrate up```
+# Guidelines
+
+Please adhere to the following guidelines when contributing:
+
+- Follow the coding style and conventions used in the project.
+- Write clear and concise commit messages.
+- Test your changes thoroughly before submitting a pull request.
+- Be respectful and constructive in all interactions with other contributors.
+
+## Code Quality and Testing
+
+- Ensure your code follows best practices and is well-documented.
+- Write unit tests for new features and ensure existing tests pass.
+- Perform code reviews and address feedback from other contributors.

README.md

@@ -1,10 +1,7 @@
 # Discord-Bot
 #### Discord bot for Tech With Tim's discord server.
+[![Invitation link](https://discord.com/api/guilds/501090983539245061/widget.png?style=banner3)](https://discord.gg/twt)
 
+# Contributing
 
-## Contributing
-* Fork the repository to your own profile, edit the code there.
-* When you are done with a feature open a pull request.
-* If you have any questions contact us in our discord server.
-
-[![Invitation link](https://discord.com/api/guilds/501090983539245061/widget.png?style=banner3)](https://discord.gg/twt)
+If you're interested in contributing, please review the [Contributing](CONTRIBUTING.md) section. For specific tasks and opportunities, explore our list of open [issues](https://github.com/SylteA/Discord-Bot/issues).