Added contribution section to README#3310
Closed
Rakina175 wants to merge 1 commit intoavinashkranjan:mainfrom
Closed
Added contribution section to README#3310Rakina175 wants to merge 1 commit intoavinashkranjan:mainfrom
Rakina175 wants to merge 1 commit intoavinashkranjan:mainfrom
Conversation
Reviewer's guide (collapsed on small PRs)Reviewer's GuideAdds 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
Tips and commandsInteracting with Sourcery
Customizing Your ExperienceAccess your dashboard to:
Getting Help
|
There was a problem hiding this comment.
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.Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
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.
Checklist:
README.mdTemplate for README.mdrequirements.txtfile if needed.Project Metadata
If there is no-file/nothing to fill the below fields with, then type: noneExample:If no requirements.txt needed/present, then type none inRequirments.Category:
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
.pyfile (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: