Skip to content

docs: add CONTRIBUTING.md as a best-practices reference for contributors - #92

Merged
knecasov merged 1 commit into
containers:mainfrom
rosygmiki:add-contributing
May 11, 2026
Merged

docs: add CONTRIBUTING.md as a best-practices reference for contributors#92
knecasov merged 1 commit into
containers:mainfrom
rosygmiki:add-contributing

Conversation

@rosygmiki

@rosygmiki rosygmiki commented May 4, 2026

Copy link
Copy Markdown
Collaborator

CONTRIBUTING.md file to guide new contributors through the development workflow, commit requirements, and PR process for the tar-diff project.

A "Contributing to tar-diff" section has also been added to README.md directing users to the guide

The key sections in this PR include:

  • Prerequisites and setup
  • Development workflow
  • DCO signoff and commit signing requirements
  • Conventional commits format with examples
  • Testing and validation instructions
  • Code quality standards and PR process
  • Merge vs squash strategy for clean git history

Co-Authored-By: Claude Sonnet 4.5 noreply@anthropic.com

@gemini-code-assist gemini-code-assist Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

Code Review

This pull request introduces a comprehensive CONTRIBUTING.md file outlining the project's development workflow, commit standards, and testing procedures. Feedback was provided to correct a typo and remove trailing whitespace in the introduction, as well as to update the minimum Go version requirement to 1.26 to align with the project's go.mod file.

Comment thread CONTRIBUTING.md Outdated
Comment thread CONTRIBUTING.md Outdated
@codecov

codecov Bot commented May 4, 2026

Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 79.37%. Comparing base (3a306a0) to head (77cff7f).
⚠️ Report is 1 commits behind head on main.

Additional details and impacted files
@@            Coverage Diff             @@
##             main      #92      +/-   ##
==========================================
+ Coverage   79.19%   79.37%   +0.17%     
==========================================
  Files          10       10              
  Lines        1115     1115              
==========================================
+ Hits          883      885       +2     
+ Misses        134      133       -1     
+ Partials       98       97       -1     

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

@rosygmiki
rosygmiki force-pushed the add-contributing branch 3 times, most recently from 2339171 to 2faade9 Compare May 5, 2026 14:40

@kgiusti kgiusti left a comment

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

Thanks for adding this! I had a couple of recommendations for you to consider - see inline.

Comment thread CONTRIBUTING.md Outdated
Comment thread CONTRIBUTING.md
Comment thread CONTRIBUTING.md Outdated
Comment thread CONTRIBUTING.md Outdated
Comment thread CONTRIBUTING.md Outdated
Comment thread CONTRIBUTING.md Outdated
Comment thread CONTRIBUTING.md Outdated
Comment thread CONTRIBUTING.md Outdated
Comment thread CONTRIBUTING.md Outdated
Comment thread CONTRIBUTING.md Outdated
Comment thread CONTRIBUTING.md Outdated
Comment thread CONTRIBUTING.md Outdated
Comment thread CONTRIBUTING.md Outdated
Comment thread CONTRIBUTING.md Outdated
Comment thread CONTRIBUTING.md Outdated
Comment thread README.md Outdated
Comment thread README.md Outdated
Comment thread README.md Outdated

@knecasov knecasov left a comment

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

I added several comments.

@rosygmiki
rosygmiki force-pushed the add-contributing branch from 2faade9 to 6baf1a8 Compare May 7, 2026 20:01
Comment thread CONTRIBUTING.md

@kgiusti kgiusti left a comment

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

Thanks for the updates!

@rosygmiki
rosygmiki force-pushed the add-contributing branch 2 times, most recently from cf98a30 to 4070a35 Compare May 11, 2026 13:51
Comment thread README.md Outdated
Comment thread README.md Outdated
Signed-off-by: Rosy-Glorious Miki <rmiki@redhat.com>

@knecasov knecasov left a comment

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

LGTM, thank you very much for your patience in incorporating all my notes!

@knecasov
knecasov merged commit e78a156 into containers:main May 11, 2026
12 of 14 checks passed
@rosygmiki
rosygmiki deleted the add-contributing branch May 11, 2026 19:37
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.

3 participants