-
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
make setup currently fails because the Makefile references a file that does not exist:
- File:
Makefile - Line: setup target runs
$(VENV_PIP) install -r tests/requirements.txt - Current state: there is no
tests/requirements.txtin the repository
This creates a broken first-run experience for new contributors following CONTRIBUTING.md.
Please update the setup flow so it installs test/dev dependencies from a real, maintained source.
A good fix is to use project extras from pyproject.toml (for example .[dev]) or another single canonical source.
Also update the setup explanation in CONTRIBUTING.md so docs match the command behavior.
Area touched:
MakefileCONTRIBUTING.md
β Acceptance Criteria
-
make setupno longer references a missingtests/requirements.txtfile - Dev/test dependencies (including pytest + pytest-cov) are installed by setup
-
CONTRIBUTING.mdsetup instructions match the updated command behavior - Existing tests still pass (
make test) - PR is linked to this issue with
Fixes #<number> - PR title follows Conventional Commits format