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.