Skip to content

docs: improve CONTRIBUTING.md for setup and testing clarity#23

Merged
Incharajayaram merged 6 commits intopointblank-club:mainfrom
sm-28601:docs-fix-contributing
Jan 23, 2026
Merged

docs: improve CONTRIBUTING.md for setup and testing clarity#23
Incharajayaram merged 6 commits intopointblank-club:mainfrom
sm-28601:docs-fix-contributing

Conversation

@sm-28601
Copy link
Copy Markdown
Contributor

@sm-28601 sm-28601 commented Jan 20, 2026

  • Added Git LFS requirement
  • Clarified toolchain verification
  • Updated testing section based on actual outputs
  • Updated project structure for new contributors

Copilot AI review requested due to automatic review settings January 20, 2026 07:11
@github-actions github-actions Bot added documentation Improvements or additions to documentation dependencies enhancement New feature or request frontend size-M Size label for PR with 62 lines changed labels Jan 20, 2026
Copilot AI reviewed Jan 20, 2026
View reviewed changes
Copy link
Copy Markdown
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

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

Pull request overview

This PR improves the CONTRIBUTING.md documentation by standardizing project naming, adding Git LFS setup instructions, and updating setup/testing procedures to match actual repository structure.

Changes:

  • Standardized project name from "IRis" to "IRIS" throughout the document for consistency with README.md
  • Added dedicated Git LFS setup section with installation and pull commands
  • Removed references to non-existent test_tools.sh script and replaced with manual toolchain verification commands
  • Updated project structure section to reflect current repository organization

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Comment thread CONTRIBUTING.md Outdated
Comment thread CONTRIBUTING.md Outdated
@github-actions github-actions Bot added size-M Size label for PR with 62 lines changed and removed size-M Size label for PR with 62 lines changed labels Jan 20, 2026
Copilot AI reviewed Jan 20, 2026
View reviewed changes
Copy link
Copy Markdown
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

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

Pull request overview

Copilot reviewed 1 out of 1 changed files in this pull request and generated 2 comments.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Comment thread CONTRIBUTING.md Outdated
Comment thread CONTRIBUTING.md Outdated
@github-actions github-actions Bot added size-M Size label for PR with 62 lines changed and removed size-M Size label for PR with 62 lines changed labels Jan 20, 2026
@YashSuthar983
Copy link
Copy Markdown
Collaborator

YashSuthar983 commented Jan 22, 2026

Looks good to me .

@Incharajayaram
Update CONTRIBUTING.md
c7099d3 
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
@github-actions github-actions Bot added size-M Size label for PR with 62 lines changed and removed size-M Size label for PR with 62 lines changed labels Jan 23, 2026
@Incharajayaram
Update CONTRIBUTING.md
699e0c2 
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
@github-actions github-actions Bot added size-M Size label for PR with 62 lines changed and removed size-M Size label for PR with 62 lines changed labels Jan 23, 2026
Incharajayaram
Incharajayaram previously approved these changes Jan 23, 2026
View reviewed changes
@Incharajayaram
Copy link
Copy Markdown
Member

Incharajayaram commented Jan 23, 2026

Merging these changes. Thanks!

@Incharajayaram
Copy link
Copy Markdown
Member

Incharajayaram commented Jan 23, 2026

@sm-28601 Please ensure all tests pass
I see code quality CI failing

@github-actions github-actions Bot added size-M Size label for PR with 62 lines changed and removed size-M Size label for PR with 62 lines changed labels Jan 23, 2026
@sm-28601
Copy link
Copy Markdown
Contributor Author

sm-28601 commented Jan 23, 2026

@sm-28601 Please ensure all tests pass I see code quality CI failing

Fixed the formatting issue (extra blank space) that was causing CI to fail.
Pushed the update — please re-check CI. ✅

@Incharajayaram Incharajayaram merged commit d8c0cf9 into pointblank-club:main Jan 23, 2026
5 of 6 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

Copilot code review Copilot Copilot left review comments

@Incharajayaram Incharajayaram Incharajayaram left review comments

@Zrahay Zrahay Awaiting requested review from Zrahay

Assignees

No one assigned

Labels

dependencies documentation Improvements or additions to documentation enhancement New feature or request frontend size-M Size label for PR with 62 lines changed

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

5 participants

@sm-28601 @YashSuthar983 @Incharajayaram @Zrahay