Gathering Contributor's Feedback

[arkid15r]

Posting on behalf of @ankushhKapoor

Hey everyone!
I’ve been going through the contribution guidelines and had a few suggestions to improve clarity and make onboarding easier for new contributors .
Here are a few ideas I had in mind:

1. Mention the Order in Which Holidays Should Be Added
   It would be helpful to clearly define the expected order for adding holidays in a country file (e.g., by date national before regional, solar before lunar calendar, etc.). This would make things more consistent and easier to review.
2. Add Examples for Good PRs
   A small section or a link to a well-structured pull request — including clean code, proper tests, and references — could serve as a great reference model for new contributors.
3. Rewrite the Localization Section as a Checklist or Step-by-Step Format
   The current localization section is a bit dense. Breaking it down into a bullet-point or numbered to-do format would make it much easier to follow, especially for first-time contributors working on translations.
4. Briefly Explain HolidayBase and ObservedHolidayBase
   Adding a short note in the contribution guidelines about what HolidayBase and ObservedHolidayBase classes are, and when each should be used, would help new contributors understand the underlying structure better.
   Let me know what you think! If these changes make sense, I’d be happy to help with drafting them further. 😊

— Ankush

[arkid15r]

Maybe it'd make sense to look into dev env dockerization? Make tests running in a container with the code base mounted as a volume. I didn't PoC it yet, just an idea to consider.

[ankushhKapoor]

That sounds like a great idea. From what I understand, Docker would basically replace the make setup and make check steps, right? I'm not familiar with Docker yet, so just trying to wrap my head around how it fits into the workflow. 😅

[arkid15r]

The make targets will stay, the idea is to run them in a container. I can work on Docker part.