CONTRIBUTING.md

Contributing to Discord bot

This discord bot is designed to waste time in the discord universe, We're excited to have you as a contributor. Here are some guidelines to help you get started and make your contribution as smooth as possible.

Table of Contents

• How Can I Contribute?
  • Reporting Bugs
  • Suggesting Enhancements
  • Code Contribution
• Getting Started
  • Prerequisites
  • Setting Up the Development Environment
• Development Workflow
  • Creating a Branch
  • Making Changes
  • Testing
  • Committing Changes
  • Opening a Pull Request
• Acknowledging Contributors

🤔 How Can I Contribute?

🪲 Reporting Bugs

If you encounter a bug or issue with the bot, please open an issue on our GitHub repository. Be sure to include:

• Use the issue template provided
• A clear and descriptive title.
• A detailed description of the issue, including steps to reproduce.
• Label the issue appropriately
• Provide relevant information such as screenshots, logs, etc.
• Be respectful and constructive

💡 Suggesting Enhancements

Have an idea for an improvement or a new feature? We'd love to hear it! Please open an issue on our GitHub repository and provide:

• A concise and clear description of your idea or enhancement request.
• Any relevant context or use cases.

Code Contribution

We welcome code contributions from the community. Here's how you can get started:

Getting Started

To get started, you need to have node.js and npm installed on your machine. You also need to have a supabase project with the following services enabled: Authentication, database, and Storage.

Prerequisites

Before you begin, make sure you have the following installed:

• Node.js
• Discord.js
• supabase

🧑‍💻 Setting Up the Development Environment

1. Fork the repository on GitHub.

2. Clone your forked repository to your local machine:

   git clone https://github.com/<your-namme>/sinan.git

   for example:

   git clone https://github.com/TinkerHub/sinan.git

3. Create a virtual environment and install the project dependencies:

   • In the project directory

     cd sinan

   • Install the project dependencies

     npm install

4. Configure discord and supabase credentials:

   • Copy the .env.example to .env

     cp .env.example .env

   • Copy the config.example.json to .env

     cp config.example.json config.json

   • Add your credentials to it

5. Run the project

   npm run build && npm start

Development Workflow

🌿 Creating a Branch

Before you start making changes, create a new branch for your feature or bug fix:

git checkout -b feature-FeatureName

if its a issue / bug:

git checkout -b issue-IssueName

Making Changes

Make your code changes in the branch you created. Be sure to follow our coding style and conventions.

Testing

Test your changes thoroughly to ensure they work as expected.

Committing Changes

When you're ready to commit your changes, follow these guidelines for your commit messages:

• Use descriptive commit messages.
• Reference issue numbers if your commit relates to a specific issue.

Opening a Pull Request

When you're ready to submit your changes, open a pull request (PR) on GitHub. Be sure to:

• Provide a clear and descriptive title for your PR.
• Include details of what your PR accomplishes.
• Mention the issue(s) your PR addresses (if applicable).
• Request a review from the maintainers.
• We will review your PR as soon as possible and provide feedback if needed.

Acknowledging Contributors

We appreciate and acknowledge all the contributors and their work for this project. We credit them in the README.md file and thank them in the pull request comments. You can see the list of the contributors and their roles here.