Skip to content

Latest commit

 

History

History
63 lines (39 loc) · 1.69 KB

PULL_REQUEST.md

File metadata and controls

63 lines (39 loc) · 1.69 KB
Raw

Submitting a PR

This page discusses the common case of contributing a new spider to the project:

  • if possible keep to the rule of one PR for one spider
  • follow naming conventions
  • your spider should nearly always include Wikidata
  • a PR title like "Add great_name_za spider (500 locations)" is informative as to scale
  • if you have something you want people to know going forward add it as a comment to the spider and not the PR

Our automation is going to check (and reject) your code for unused imports and "poor" formatting. To avoid being bitten too often by these you can add some pre-commit hooks we provide in the project:

$ git config core.hooksPath contrib/hooks

In particular this will activate import clean up and code formatting prior to you performing a local project commit.

Instead of, or as well as Git Hooks you could set up your IDE to do it for you. The below details are for IntelliJ IDEA File Watchers but similar will be possible with different IDEs.

isort

File Types: python

Program: $PyInterpreterDirectory$/isort

Arguments: $FilePath$ --profile black

Output paths to refresh: $FilePath$

Working directory $ProjectFileDir$

autoflake8

File Types: python

Program: $PyInterpreterDirectory$/autoflake8

Arguments: $FilePath$ --in-place

Output paths to refresh: $FilePath$

Working directory $ProjectFileDir$

black

File Types: python

Program: $PyInterpreterDirectory$/black

Arguments: $FilePath$

Output paths to refresh: $FilePath$

Working directory $ProjectFileDir$