Hacktoberfest 2026: the issues maintainers tagged for October, open and beginner-friendly. Browse Hacktoberfest issues

GitHub Action: check that every solution file has a header comment

Open Beginner friendly
  • Is something wrong?
#116 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty
2/5
Estimated time
1-3 hours
Newbie friendliness
78/100
Issue type
Feature
Clarity
Clearly specified
Activity status
Active
Tech stack
bash, github-actions, node.js, python
Domain
ci-cd, tooling

Research direction

Start by reviewing existing files under .github/workflows/ and the layout of solutions/ to see how changed files can be identified in pull requests. Add a small script to check the first lines of changed solution files for Problem:, Source:, and Note: using # or // comments, then have the workflow fail with a clear list of files missing headers. Done when the check runs on pull requests and reports missing headers; matching practice<n>.<ext> is a bonus.

Written by the indexing model from the issue text.

Description

1-hour all-levels automation ci codewars enhancement github-actions hackerrank hacktoberfest help wanted interview-prep leetcode medium open-source python students tooling

Every solution is supposed to start with a comment containing Problem, Source, and Note lines. Nothing enforces that yet.

Time: about an hour
Skills: GitHub Actions basics, and a bit of Python, Bash, or Node

What to build
  • A workflow in .github/workflows/ that runs on pull requests
  • A small script that scans changed files under solutions/ and checks the first lines for Problem:, Source:, and Note: (accept # and // comment styles)
  • Fail the check with a clear message listing the files that are missing a header

Bonus: also check the file name matches practice<n>.<ext>.

Who can take this

Anyone. Beginners, experienced developers, students, and people who do not code. Any language, any level. If you want to help, you are welcome here.

How to contribute

  1. Comment on this issue so nobody else starts the same thing
  2. Fork the repo
  3. Clone your fork and create a branch
  4. Make your change
  5. Commit, push, and open a Pull Request

Never opened a pull request before? Start with First Contributions or watch this walkthrough.

Stuck on anything? Ask in the comments. Basic questions are fine.

If this repo helps you or you like where it is going, a star is a nice way to say thanks and helps other people find it. Entirely optional, and you do not need it to contribute.

Dominant language
Python
Stars
3
Forks
2
Avg merge
2h 33m
Merged PRs (30d)
6

Getting set up

This project ships no dev container, Dockerfile or contributing guide, so setting up is up to you: start from its README, and see our first-contribution guide for the general steps.

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from Huerte/algo-solutions-python

All issues in Huerte/algo-solutions-python

Similar issues

More Python issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.