From 44a7c6b1f53db2e6c29ec4491bc3d7ca229b56a4 Mon Sep 17 00:00:00 2001 From: Alex Selesse Date: Thu, 13 Jan 2022 18:58:55 -0500 Subject: [PATCH] Update contribution guideline testing instructions The testing instructions don't talk about how to test the integration between holiday and definitions. This updates the CONTRIBUTING doc to make sure it's easily discoverable by new contributors. --- doc/CONTRIBUTING.md | 10 ++++++++++ 1 file changed, 10 insertions(+) diff --git a/doc/CONTRIBUTING.md b/doc/CONTRIBUTING.md index 46f82e1..9146c6e 100644 --- a/doc/CONTRIBUTING.md +++ b/doc/CONTRIBUTING.md @@ -15,6 +15,16 @@ Here are the steps to take once you have a good idea on what you want to change: * Fork this repository * Edit desired definition YAML file(s). If you are adding a new region be sure to update `index.yaml` as well * Run `make validate` to ensure that all updates match our definition format +* Ensure that the tests in holidays pass: +``` +git clone git@github.com:holidays/holidays.git +cd holidays +bundle install +make clean-defs +BRANCH= USER= make point-to-defs-branch +bundle exec rake generate:definitions +bundle exec rake test # Alternatively: bundle exec rake test_region +``` * Open a PR with your changes Including documentation with your updates is very much appreciated. A simple Wikipedia entry or government link in the comments alongside your changes would be perfect.