Skip to content

Latest commit

 

History

History
49 lines (30 loc) · 1.35 KB

CONTRIBUTING.md

File metadata and controls

49 lines (30 loc) · 1.35 KB

Hey! 😄

Thank you so much for take your time to contribute here! We're so active and contributes are welcome!

Make a pull request 👨🏽‍💻

We gladly accept pull request for new rules, projects, features, bug fixes, minor corrections, etc.

Developing 🔨

In order to develop, you have two options:

  1. Improve Projects
  2. Create new Projects

Important 🛑

You must create and activate a Python3 virtual environment.

and then, you can continue with:

pip install -r requirements.txt

Run code style checks:

flake8

Improve Projects ⚒️

You can improve the other projects, you just need to read carefully the Readme.md of the project.

Create new Projects ⛏️

We accept all type or projects, the only rule scripts written in Python, so feel free to create and pull your python projects.

Take in consideration the next points:

  1. Create new folder for your project (lowercases and without whitespaces, you could use - or _)
  2. Add README.md in your project
  3. Add requirements.txt in your project with the only necessary packages