Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Update contribution guideline testing instructions #213

Merged
merged 1 commit into from
Sep 4, 2022
Merged

Update contribution guideline testing instructions #213

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 10 additions & 0 deletions doc/CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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 [email protected]:holidays/holidays.git
cd holidays
bundle install
make clean-defs
BRANCH=<YOUR_BRANCH_NAME> USER=<YOUR_GITHUB_USERNAME> make point-to-defs-branch
bundle exec rake generate:definitions
bundle exec rake test # Alternatively: bundle exec rake test_region <your_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.
Expand Down