Firstly we are really grateful to you that you are considering contributing to Tattle's Kosh. We welcome contributions of all sorts - filing a bug report, suggesting improvements, proposing new feature, adding documentations, writing tests etc.
By contributing to Kosh, you are agreeing to our community guidelines (will be linked soon)
Contributing to Kosh takes 4 easy steps
👋 Say Hi
🔨 Do your thing
📞 Merge with Master
🎉 Celebrate
Small changes in a fact-checking website structure can cause the scraper to break. At any given time, there can be multiple issues with the scraper that are listed on Github Issues. You can also create a new GitHub issue if you spot a bug. Reach out to the team with the issue(s) you want to tackle.
- Fork the Github Repo.
- If you don't have an S3 account you can write to, replace lines uploading error files to s3 in live_scraping.py with a local destination. You could also comment them out if you are not interested in the error logs.
All code changes happen via pull request. We use Github Flow. The easiest way to let us know if you want to combine your changes into the core code is to make a Pull Request (PR) In your PR, please mention the following :
- What does this PR do?
- How do we test this PR?
We don't strictly follow test driven development (TDD) but any contributions that include tests are greatly appreciated.
Add/amend a readme file describing the changes you've made.
We typically review a PR within 2-3 days. We might offer you some feedback to your PR and merge it! If you reached till this stage, Congratulations and join us afterwards for virtual coffee/tea on slack 🙂
When you submit code changes, your submissions are understood to be under the same licence that covers the project - GPL-3. Feel free to contact the maintainers if that's a concern.