Skip to content

Latest commit

 

History

History
193 lines (124 loc) · 5.15 KB

CONTRIBUTING.md

File metadata and controls

193 lines (124 loc) · 5.15 KB

Contributing to EventManager

Welcome to EventManager, 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

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 Python 3, pip, and virtualenv installed on your machine. You also need to have a Firebase project with the following services enabled: Authentication, Firestore, and Storage. You need to download the Firebase SDK service account key and save it as firebase-key.json in the project folder.

Prerequisites

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

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>/EventManager.git

    for example:

    git clone https://github.com/TinkerHub-AISAT/EventManager.git

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

    • In the project directory

      cd EventManager

    • Create a virtual environment

      For Windows use :

      python -m venv .venv

      For Mac or Linux use :

      python3 -m venv .venv

    • Activate the environment :

      For Windows use :

      .\.venv\Scripts\Activate.ps1

      For Mac or Linux use :

      source .venv/bin/activate

    • Install the project dependencies

      For Windows use :

      pip install -r requirements.txt

      For Mac or Linux use :

      pip3 install -r requirements.txt

  4. Configure supabase credentials:

    • Copy the env_example to .env

      cp env_example .env

    • Add your credentials to it

  5. Run the project

    • For Windows use :

      python main.py

    • For Mac or Linux use :

      python3 main.py

    The project will be available at http://localhost:5000/

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].