Git Product home page Git Product logo

discord-bot's Introduction

discord-bot

Python precommit


Getting Started

Prerequisites

Installing

  1. Clone the repository using Git.
git clone [email protected]:leandcesar/discord-bot.git
  1. Go to directory.
cd discord-bot

Running

  1. Ensure to fill in the necessary environment variables in the .env file.
  2. Build the Docker service for the application.
make build
  1. Check if everything was installed correctly.
make up

Cleaning up

  1. Uninstall all Docker components.
make down

Contributing

Prerequisites

Development

  1. Create a venv and install dependencies with pip.
make install
  1. Create a new branch with a descriptive name.
git checkout -b awesome-branch-name
  1. Implement and add your code changes on this new branch.

Code Style

  1. Perform static code analysis with ruff and mypy.
make lint
  1. Validate code security issues with bandit.
make security
  1. Format the code according to defined standards with black and organize imports with isort.
make format

Contribute

  1. Commit your changes to your local branch using Conventional Commit messages.
git add .
git commit -m 'feat(scope): example message'
  1. Push your changes to the remote GitHub repository.
git push origin awesome-branch-name
  1. Create a Pull Request to the main branch.

Cleaning up

  1. Remove temporary files.
make clean
  1. Uninstall all dependencies.
make uninstall

References

discord-bot's People

Contributors

dependabot[bot] avatar leandcesar avatar luanfabricio avatar

Stargazers

 avatar

Watchers

 avatar

Forkers

luanfabricio

discord-bot's Issues

Enhance `/profile` command

  • Translate the Embed fields ("Cor", "Criado em", "Entrou em", "Cargos") according to inter.locale
  • Option to choose between the global or local (guild) profile picture. Suggestions:
    • or adding a parameter in the command (/profile style=local|global, default: global)
    • or adding a button below the Embed that, when clicked, switches the Embed to the other profile picture
  • Display the role badge (only for .top_role). Suggestions:
    • or upload it as an emote (if it doesn't exist) and display the emote in one of the Embed's fields
    • or place a hyperlink to access it externally
    • or adding a button below the Embed that, when clicked, sends the badge

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.