Skip to content

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

Open
rmiki-dev wants to merge 1 commit intocontainers:mainfrom
rmiki-dev:add-contributing
Open

docs: add CONTRIBUTING.md as a best-practices reference for contributors#92
rmiki-dev wants to merge 1 commit intocontainers:mainfrom
rmiki-dev:add-contributing

Conversation

@rmiki-dev
Copy link
Copy Markdown
Collaborator

@rmiki-dev rmiki-dev commented May 4, 2026

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

Copy link
Copy Markdown

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

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
Copy link
Copy Markdown

codecov Bot commented May 4, 2026

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 79.37%. Comparing base (afb00d4) to head (2faade9).
⚠️ Report is 2 commits behind head on main.

Additional details and impacted files
@@            Coverage Diff             @@
##             main      #92      +/-   ##
==========================================
+ Coverage   72.87%   79.37%   +6.49%     
==========================================
  Files          10       10              
  Lines        1412     1115     -297     
==========================================
- Hits         1029      885     -144     
+ Misses        271      133     -138     
+ Partials      112       97      -15     

☔ 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.

@rmiki-dev rmiki-dev force-pushed the add-contributing branch 2 times, most recently from 1e65cf6 to 2339171 Compare May 5, 2026 12:42
Signed-off-by: Rosy-Glorious Miki <rmiki@redhat.com>
@rmiki-dev rmiki-dev force-pushed the add-contributing branch from 2339171 to 2faade9 Compare May 5, 2026 14:40
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.

1 participant