Skip to content

Added contribution section to README#3310

Closed
Rakina175 wants to merge 1 commit intoavinashkranjan:mainfrom
Rakina175:feature-readme-update
Closed

Added contribution section to README#3310
Rakina175 wants to merge 1 commit intoavinashkranjan:mainfrom
Rakina175:feature-readme-update

Conversation

@Rakina175
Copy link

@Rakina175 Rakina175 commented Feb 12, 2026

Description

Please include a summary of the change and which issue is fixed. List any dependencies that are required for this change.

Fixes #(issue_no)

Type of change

Please delete options that are not relevant.

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to not work as expected)
  • This change requires a documentation update
  • Documentation Update

Checklist:

  • My code follows the style guidelines(Clean Code) of this project
  • I have performed a self-review of my own code
  • I have commented my code, particularly in hard-to-understand areas
  • I have created a helpful and easy to understand README.md
  • My documentation follows Template for README.md
  • I have added the project meta data in the PR template.
  • I have created the requirements.txt file if needed.

Project Metadata

If there is no-file/nothing to fill the below fields with, then type: none

Example: If no requirements.txt needed/present, then type none in Requirments.

Category:

  • Calculators
  • AI/ML
  • Scrappers
  • Social_Media
  • PDF
  • Image_Processing
  • Video_Processing
  • Games
  • Networking
  • OS_Utilities
  • Automation
  • Cryptography
  • Computer_Vision
  • Fun
  • Others

Title: <write script title here>

Folder: <type the folder name that contains your script>

Requirements: <type the name of text file containing the required to install python packages, type None if no file required>

Script: <Enter the name of the .py file (The main entry point of the program)>

Arguments: <enter any arguments that the script needs but - separeted like: h-c-m>

Contributor: <Enter your Github handle/username without url>

Description: <Enter a one line description that describes your script. Also, explain the arguments usage here>

Summary by Sourcery

Documentation:

  • Add a short contribution section crediting the contributor and explaining the purpose of the README update.

@sourcery-ai
Copy link

sourcery-ai bot commented Feb 12, 2026

Reviewer's guide (collapsed on small PRs)

Reviewer's Guide

Adds a small documentation section to the README to demonstrate Git branching and merge conflict handling, attributing the change to a specific contributor and branch.

File-Level Changes

Change Details Files
Add a short contribution/demo section to the README.
  • Insert a horizontal rule after the existing 'Happy Coding' heading to visually separate the new content.
  • Add a 'Contribution by Raki' subsection explaining that this section demonstrates branching and merge conflict resolution.
  • Document the branch name feature-readme-update as part of the demo content.
README.md

Tips and commands

Interacting with Sourcery

  • Trigger a new review: Comment @sourcery-ai review on the pull request.
  • Continue discussions: Reply directly to Sourcery's review comments.
  • Generate a GitHub issue from a review comment: Ask Sourcery to create an
    issue from a review comment by replying to it. You can also reply to a
    review comment with @sourcery-ai issue to create an issue from it.
  • Generate a pull request title: Write @sourcery-ai anywhere in the pull
    request title to generate a title at any time. You can also comment
    @sourcery-ai title on the pull request to (re-)generate the title at any time.
  • Generate a pull request summary: Write @sourcery-ai summary anywhere in
    the pull request body to generate a PR summary at any time exactly where you
    want it. You can also comment @sourcery-ai summary on the pull request to
    (re-)generate the summary at any time.
  • Generate reviewer's guide: Comment @sourcery-ai guide on the pull
    request to (re-)generate the reviewer's guide at any time.
  • Resolve all Sourcery comments: Comment @sourcery-ai resolve on the
    pull request to resolve all Sourcery comments. Useful if you've already
    addressed all the comments and don't want to see them anymore.
  • Dismiss all Sourcery reviews: Comment @sourcery-ai dismiss on the pull
    request to dismiss all existing Sourcery reviews. Especially useful if you
    want to start fresh with a new review - don't forget to comment
    @sourcery-ai review to trigger a new review!

Customizing Your Experience

Access your dashboard to:

  • Enable or disable review features such as the Sourcery-generated pull request
    summary, the reviewer's guide, and others.
  • Change the review language.
  • Add, remove or edit custom review instructions.
  • Adjust other review settings.

Getting Help

Copy link

@sourcery-ai sourcery-ai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hey - I've left some high level feedback:

  • Consider whether the personal 'Contribution by Raki' section belongs in the main README, or if this information is better suited for the PR description or a CONTRIBUTORS/CHANGELOG file to keep the README focused on end users.
  • The horizontal rule (---) directly under the centered <h1> heading may affect the visual hierarchy; you might want to align this with the rest of the README’s styling or remove it for consistency.
Prompt for AI Agents
Please address the comments from this code review:

## Overall Comments
- Consider whether the personal 'Contribution by Raki' section belongs in the main README, or if this information is better suited for the PR description or a CONTRIBUTORS/CHANGELOG file to keep the README focused on end users.
- The horizontal rule (`---`) directly under the centered `<h1>` heading may affect the visual hierarchy; you might want to align this with the rest of the README’s styling or remove it for consistency.

Sourcery is free for open source - if you like our reviews please consider sharing them ✨
Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants