Contributing to Precept

Getting Started

• Fork and clone the repo

• Create, activate & install dependencies

  $ python -m venv venv
  $ . venv/bin/activate
  $ pip install -r requirements.txt
  

Submit a PR with your changes.

Coding style

Linters

• pylint: $ pylint precept tests

• flake8: $ flake8 dazzler tests

Commit messages

Prefix your commit messages with an emoji according to this list:

Commit type	Emoji
Initial commit	tada :tada:
Version tag	bookmark :bookmark:
New feature	sparkles :sparkles:
Bugfix	bug :bug:
Metadata	card_index :card_index:
Documentation	books :books:
Documenting source code	bulb :bulb:
Performance	racehorse :racehorse:
Cosmetic	lipstick :lipstick:
Tests	rotating_light :rotating_light:
Adding a test	white_check_mark :white_check_mark:
General update	construction :construction:
Improve format/structure	art :art:
Move code	feet :feet:
Refactor code	hammer :hammer:
DRY up code	camel :camel:
Removing code/files	hocho :hocho:
Continuous Integration	green_heart :green_heart:
Security	lock :lock:
Upgrading dependencies	arrow_up :arrow_up:
Downgrading dependencies	arrow_down :arrow_down:
Lint	shirt :shirt:
Translation	alien :alien:
Text	pencil :pencil:
Critical hotfix	ambulance :ambulance:
Deploying stuff	rocket :rocket:
Fixing on MacOS	apple :apple:
Fixing on Linux	penguin :penguin:
Fixing on Windows	checkered_flag :checkered_flag:
Adding CI build system	construction_worker :construction_worker:
Analytics or tracking code	chart_with_upwards_trend :chart_with_upwards_trend:
Removing a dependency	heavy_minus_sign :heavy_minus_sign:
Adding a dependency	heavy_plus_sign :heavy_plus_sign:
Docker	whale :whale:
Configuration files	wrench :wrench:
Bundles update	package :package:
Merging branches	twisted_rightwards_arrows :twisted_rightwards_arrows:
Bad code / need improv.	hankey :hankey:
Reverting changes	rewind :rewind:
Breaking changes	boom :boom:
Code review changes	ok_hand :ok_hand:
Accessibility	wheelchair :wheelchair:
Move/rename repository	truck :truck:
Other	Be creative