How to Showcase Software Testing Projects on GitHub Properly

ui-api-test-suite/
|-- README.md
|-- requirements.txt
|-- pytest.ini
|-- .gitignore
|-- .github/workflows/tests.yml
|-- config/
|   `-- settings.py
|-- pages/            # page objects for UI tests
|   `-- login_page.py
|-- tests/
|   |-- api/
|   |   `-- test_posts.py
|   `-- ui/
|       `-- test_login.py
`-- docs/
    |-- test-plan.md
    |-- test-cases.md
    `-- bug-reports.md

# config/settings.py
import os

BASE_URL = os.getenv("BASE_URL", "https://jsonplaceholder.typicode.com")
UI_URL = os.getenv("UI_URL", "https://the-internet.herokuapp.com")
TIMEOUT = int(os.getenv("TIMEOUT", "10"))

# pytest.ini
# [pytest]
# testpaths = tests
# addopts = -q
# markers =
#     smoke: quick checks run on every push

# UI + API Test Suite

![tests](https://github.com/<your-username>/ui-api-test-suite/actions/workflows/tests.yml/badge.svg)

## What is tested
- API: posts and users endpoints (status codes, fields, invalid input)
- UI: login page on a public practice site (valid, invalid, empty)

## Tech
Python, pytest, requests, Selenium, GitHub Actions

## Run locally
    pip install -r requirements.txt
    pytest

## Results
24 tests, run on every push. Latest report: see Actions artefacts.

## Manual testing docs
Test plan, test cases and bug reports are in /docs.

# .github/workflows/tests.yml
name: tests
on: [push, pull_request]
jobs:
  test:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v4
      - uses: actions/setup-python@v5
        with:
          python-version: '3.12'
      - run: pip install -r requirements.txt pytest-html
      - run: pytest --html=reports/report.html --self-contained-html
      - uses: actions/upload-artifact@v4
        if: always()
        with:
          name: test-report
          path: reports/report.html

| ID | Title | Steps | Expected | Priority |
|----|-------|-------|----------|----------|
| TC01 | Valid login | Enter valid user and password, click Login | Secure area page shown | High |
| TC02 | Wrong password | Enter valid user, wrong password | Error message shown | High |
| TC03 | Empty fields | Click Login with both fields empty | Validation message shown | Medium |
| TC04 | Password with spaces | Add leading space to valid password | Login rejected or trimmed as per spec | Low |

# tests/ui/test_login.py
# pip install selenium (Selenium 4 manages the driver automatically)
from selenium import webdriver
from selenium.webdriver.common.by import By

URL = "https://the-internet.herokuapp.com/login"

def test_valid_login():
    driver = webdriver.Chrome()
    try:
        driver.get(URL)
        driver.find_element(By.ID, "username").send_keys("tomsmith")
        driver.find_element(By.ID, "password").send_keys("SuperSecretPassword!")
        driver.find_element(By.CSS_SELECTOR, "button[type=submit]").click()
        assert "/secure" in driver.current_url
    finally:
        driver.quit()

[ ] Clear name (e.g. ui-api-test-suite, not project1)
[ ] Short description and topics set on GitHub
[ ] README: what, tech, run steps, results
[ ] requirements.txt or package.json
[ ] Tests run with one command
[ ] CI workflow with status badge
[ ] .gitignore; no secrets committed
[ ] /docs with test plan, cases, bug reports

GitHub profile for QA freshers

- Profile README: 3 lines about you + links to best repos
- Pin 2-3 testing repos (automation, API, manual docs)
- Clear repo descriptions (one line each)
- Regular, meaningful commits (not one giant upload)
- Link your GitHub on resume and LinkedIn

Good commit messages

add API tests for invalid post IDs
move login locators into page object
add CI workflow with HTML report
document test plan scope and risks
fix flaky wait in checkout test

Avoid: 'update', 'changes', 'final', 'final2'