Skip to content

Latest commit

 

History

History
53 lines (36 loc) · 2.2 KB

CONTRIBUTING.md

File metadata and controls

53 lines (36 loc) · 2.2 KB
Raw

Contributing

Hi there! We're thrilled that you'd like to contribute to this project. Your help is essential for keeping it great.

Contributions to this project are released to the public under the project's open source license.

Please note that this project is released with a Contributor Code of Conduct. By participating in this project you agree to abide by its terms.

Submitting a pull request

  1. Fork and clone the repository
  2. Configure and install the dependencies: pip3 install -r requirements.txt
  3. Create a new branch: git checkout -b my-branch-name
  4. Push to your fork and submit a pull request
  5. Pat your self on the back and wait for your pull request to be reviewed! 🎉

Here are a few things you can do that will increase the likelihood of your pull request being accepted:

  • Follow the style guide - it'll automatically run via the super-linter.
  • Write tests.
  • Keep your change as focused as possible. If there are multiple changes you would like to make that are not dependent upon each other, consider submitting them as separate pull requests.
  • Write a good commit message.

Local development

After cloning your forked repository, you can set up your development environment by running the following commands:

# Create a virtual environment
python3 -m venv venv
source venv/bin/activate

# Install dependencies
pip3 install -r requirements.txt

To execute the python script main.py locally you will need to setup the required environment variables. You can do this by making a copy of .env-sample into .env file in the root of the project and edit the values to match your environment.

source .env

You can now run the script locally:

python3 main.py

Resources