|
| 1 | +# Contributing to Holidata |
| 2 | + |
| 3 | +Thank you for considering contributing to Holidata! |
| 4 | +This document outlines how you can help maintain and update holiday data. |
| 5 | + |
| 6 | +## Maintaining Holiday Data |
| 7 | + |
| 8 | +Help keep our holiday data accurate by: |
| 9 | + |
| 10 | +1. Monitoring official government publications and legal documents |
| 11 | +2. Identifying changes such as: |
| 12 | + - Newly established holidays |
| 13 | + - Abolished holidays |
| 14 | + - Date/observance rule changes |
| 15 | + - Regional observance pattern updates |
| 16 | + - Name/official designation changes |
| 17 | + |
| 18 | +3. Verifying against primary sources (official government documents) |
| 19 | +4. Updating relevant files in `src/holidata/holidays/` |
| 20 | + |
| 21 | +## Updating Holidays |
| 22 | + |
| 23 | +For guidance on how holidays are defined in the code, refer to [docs/how-tos/define-holidays.md](docs/how-tos/define-holidays.md). |
| 24 | +This should help you when you want to make changes. |
| 25 | + |
| 26 | +## Adding New Countries |
| 27 | + |
| 28 | +If you want to add a new country to Holidata, please follow the detailed guide in [docs/how-tos/add-country.md](docs/how-tos/add-country.md). |
| 29 | +Of course, we would be very happy if you could as well help to maintain this country afterward. |
| 30 | + |
| 31 | +## Adding Languages |
| 32 | + |
| 33 | +To add additional languages for a country, see [docs/how-tos/add-locales.md](docs/how-tos/add-locales.md). |
| 34 | + |
| 35 | +## Submitting Your Contribution |
| 36 | + |
| 37 | +Before you begin, make sure you have set up your development environment by following the instructions in [docs/how-tos/getting-started.md](docs/how-tos/getting-started.md). |
| 38 | + |
| 39 | +Once you've made your changes, update the snapshot files such that they reflect the updated state of the data |
| 40 | +```bash |
| 41 | +pytest --snapshot-update |
| 42 | +``` |
| 43 | + |
| 44 | +Finally, submit a pull request with a clear description of your changes and the sources you used for verification. |
| 45 | + |
| 46 | +## Code Style and Best Practices |
| 47 | + |
| 48 | +- Follow PEP 8 style guidelines |
| 49 | +- Write clear, descriptive docstrings using Google-style format |
| 50 | +- Keep your changes focused and well-documented |
| 51 | + |
| 52 | +Thank you for helping to maintain accurate holiday data for Holidata! |
0 commit comments