Skip to main content
Thank you for your interest in contributing to the Ouckah & CSCareers Internship List! This repository makes it easy to add internships through an automated submission process.

​
Contribution Workflow

The entire contribution process is automated through GitHub issues. Once you submit an internship, our team reviews it and the system automatically adds it to the appropriate README.
1

Create a New Issue

Navigate to the GitHub repository and create a new issue.
2

Select the New Internship Template

Choose the New Internship issue template from the available options.
3

Fill Out the Form

Complete all required fields in the issue form with information about the internship. See Submission Guidelines for detailed guidance on each field.
Please make a new submission for each unique position, even if they are for the same company.
4

Submit and Wait for Review

Submit the issue and wait for a team member to review your submission.

​
What Happens After Submission

Once you’ve submitted your internship:
  1. Review: A team member reviews your submission to ensure it meets the internship requirements
  2. Approval: If approved, the issue is labeled with approved
  3. Automation: A GitHub Action workflow automatically:
    • Extracts the internship data from your issue
    • Adds it to the listings.json file
    • Updates the appropriate README file
    • Commits the changes to the repository
    • Closes your issue with a success message
The automation is handled by the contribution_approved.yml workflow, which triggers when an issue receives the approved label:
name: Contribution Approved

on:
  issues:
    types: ["labeled"]

jobs:
  run-python-script:
    runs-on: ubuntu-latest
    if: github.event.label.name == 'approved'
    
    steps:
      - name: execute contribution_approved.py
        run: python .github/scripts/contribution_approved.py
        
      - name: execute update_readmes.py
        run: python .github/scripts/update_readmes.py
        
      - name: Auto Close Issue
        run: gh issue close --comment "Your contribution was accepted. Auto-closing issue"

​
How Your Internship Appears

Your internship will be automatically formatted and added to the README as a table row:
CompanyRoleLocationApplication/LinkDate Posted
Example CompanySoftware Engineering Internship ExampleSan Francisco, CAApply Button

​
Alternative Contribution Methods

Beyond adding new internships, you can contribute in other ways:
  • Close an Internship: Use the Close Internship template to report positions that are no longer accepting applications. Provide the company name, role title, and reason for closing.
  • Ask Questions or Suggest Improvements: Use the Other template to ask questions, suggest new features, or provide feedback that doesn’t fit the other templates.
Make sure you’ve read the Internship Requirements before submitting to ensure your contribution meets our criteria.

Build docs developers (and LLMs) love

Get started for freeTalk to us