Skip to content

Commit

Permalink
Include a "how to contribute" section in the README.md (#26)
Browse files Browse the repository at this point in the history
  • Loading branch information
dcaribou authored Aug 14, 2021
1 parent 3a5cf37 commit 3e5d043
Showing 1 changed file with 8 additions and 0 deletions.
8 changes: 8 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -52,3 +52,11 @@ Check out [player-scores](https://github.com/dcaribou/player-scores) to see `tra

## config
Check [setting.py](tfmkt/settings.py) for a reference of available configuration options

## contribute
Extending existing crawlers in this project in order to scrape additional data or even creating new crawlers is quite straightforward. If you want to contribute with an enhancement to `transfermarkt-scraper` I suggest that you follow a workflow similar to
1. Fork the repository
2. Modify or add new crawlers to `tfmkt/spiders`. [Here is an example PR](https://github.com/dcaribou/transfermarkt-scraper/pull/25/files) that extends the `games` crawler to scrape a few additional fields from Transfermakt games page.
3. Create a PR with your changes and a short description for the enhancement and send it over :rocket:

It is usually also a good idea to have a short discussion about the enhancement beforehand. If you want to propose a change and collect some feeback before you start coding you can do so by creating an issue with your idea in the [Issues](https://github.com/dcaribou/transfermarkt-scraper/issues) section.

0 comments on commit 3e5d043

Please sign in to comment.