-
Notifications
You must be signed in to change notification settings - Fork 14
Description
Welcome to New Grad Jobs! π
This template creates a Good First Issue β a small, guided task that helps new
contributors learn the codebase and contribution workflow.
Good First Issues are pre-approved by the maintainer. A contributor can claim it
immediately by commenting /assign.
π Newcomer Friendly
This is a Good First Issue β a guided, well-scoped task designed for contributors
who are new to this repository.
What you'll do
- β Read a small part of the codebase
- β Make a focused, well-defined change
- β Write or extend a test
- β Submit and merge a pull request
Support
The maintainer actively monitors Good First Issues and will respond to questions
within 24β48 hours.
Important
This issue does not require prior scraping or API experience.
- Basic Python and Git are sufficient
- You must be assigned before starting β comment
/assignto claim this issue - Read CONTRIBUTING.md
before opening a PR
Note
β±οΈ Typical time to complete: 30β90 minutes (once local setup is done)
π§© Difficulty: Small, well-contained change
π Best for: First-time contributors
π When this issue is complete, you will have:
- β A merged PR in a real open-source project
- β Your name in the Contributors Hall of Fame
- β Confidence to take on larger issues next
Important
π What makes a Good First Issue in this repo?
Often a good fit:
- Adding a missing company to
config.yml(Greenhouse, Lever endpoint) - Fixing a keyword in
categorize_job()orget_company_tier() - Correcting a typo or broken link in documentation
- Adding a test case for an existing, already-working function
- Small CSS/HTML improvements to
docs/
Not a good fit for GFI:
- Changes to
filter_jobs(),deduplicate_jobs(), or date parsing - New scraping source integrations (Workday, Google Careers)
- Architectural changes to
update_jobs.py
Those belong in Beginner, Intermediate, or Advanced issues.
πΎ Task Description
Contributor docs currently conflict with workflow behavior for Hall of Fame credit:
CONTRIBUTING.mdsays maintainers will add contributors manually.github/workflows/auto-thank.ymlattempts automatic credit on merged PRs
This causes confusion when contributors expect immediate credit or when automation skips a case.
Please add a short, clear section in CONTRIBUTING.md that explains:
- Which workflow handles contributor credit (
auto-thank.yml) - When it triggers (PR is merged)
- Common skip conditions (for example bot authors)
- What to do if credit did not appear (open a comment / maintainer follow-up)
Keep this concise and contributor-friendly.
Area touched:
CONTRIBUTING.md- (Reference only)
.github/workflows/auto-thank.yml
β Acceptance Criteria
-
CONTRIBUTING.mdincludes a clear "Hall of Fame credit" section aligned with current workflow behavior - New section references
.github/workflows/auto-thank.ymlas the source of truth - Instructions include a simple troubleshooting path if auto-credit does not run
- Existing docs still pass repository checks (pre-commit/markdown checks if configured)
- PR is linked to this issue with
Fixes #<number> - PR title follows Conventional Commits format