Fix readme project name#25
Conversation
github-actions
Bot
added
documentation
There was a problem hiding this comment.
Pull request overview
This PR attempts to standardize the project name but introduces critical inconsistencies by changing the name in opposite directions across different files. The README.md changes "IRIS" to "IRis" while CONTRIBUTING.md changes "IRis" to "IRIS", creating confusion about the correct project name. Additionally, the PR includes unrelated documentation updates for Git LFS setup, toolchain verification, and project structure.
Changes:
- Updated project name in README.md from "IRIS" to "IRis"
- Updated project name in CONTRIBUTING.md from "IRis" to "IRIS" (opposite direction)
- Added Git LFS setup documentation and warning section
- Updated toolchain verification instructions from script-based to manual commands
- Expanded and updated project structure documentation
Reviewed changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated 5 comments.
| File | Description |
|---|---|
| README.md | Changed project title from "IRIS" to "IRis" |
| CONTRIBUTING.md | Changed project name from "IRis" to "IRIS" throughout the file, added Git LFS documentation, updated toolchain verification to manual commands, and expanded project structure documentation |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
| @@ -1,4 +1,4 @@ | |||
| # IRIS — ML-Guided RISC-V Compiler Optimization | |||
| # IRis — ML-Guided RISC-V Compiler Optimization | |||
There was a problem hiding this comment.
Inconsistent project name changes across files. This change renames the project from "IRIS" to "IRis" in README.md, but CONTRIBUTING.md changes go in the opposite direction (from "IRis" to "IRIS"). This creates confusion about the correct project name. The two files should use the same project name consistently.
| # IRis — ML-Guided RISC-V Compiler Optimization | |
| # IRIS — ML-Guided RISC-V Compiler Optimization |
| # Contributing to IRIS | ||
|
|
||
| Thank you for your interest in contributing to IRis! This document provides guidelines and instructions for contributing to this ML-powered compiler optimization project for RISC-V. | ||
| Thank you for your interest in contributing to IRIS! This document provides guidelines and instructions for contributing to this ML-powered compiler optimization project for RISC-V. |
There was a problem hiding this comment.
Inconsistent project name changes across files. This change renames the project from "IRis" to "IRIS" in CONTRIBUTING.md, but README.md changes go in the opposite direction (from "IRIS" to "IRis"). This creates confusion about the correct project name. The two files should use the same project name consistently.
| git clone https://github.com/your-username/IRIS.git | ||
| cd IRIS |
There was a problem hiding this comment.
Inconsistent project name in repository URLs. These URLs use "IRIS" but the project name in README.md has been changed to "IRis". Ensure all references to the project name are consistent across documentation.
| └── iris-website/ # Full-stack web application | ||
| ├── src/ # Next.js frontend | ||
| └── backend/ # Flask REST API | ||
| IRIS/ |
There was a problem hiding this comment.
Inconsistent project name in directory structure documentation. The root directory is named "IRIS/" but the project name in README.md has been changed to "IRis". Ensure all references to the project name are consistent across documentation.
| --- | ||
|
|
||
| Thank you for contributing to IRis! Your efforts help advance ML-powered compiler optimization for the RISC-V ecosystem. | ||
| Thank you for contributing to IRIS! Your efforts help advance ML-powered compiler optimization for the RISC-V ecosystem. |
There was a problem hiding this comment.
Inconsistent project name in closing statement. This uses "IRIS" but the project name in README.md has been changed to "IRis". Ensure all references to the project name are consistent across documentation.
|
@sm-28601 Sorry for your time, but we think IRIS is good. |
This PR updates the project name IRIS to IRis across the README .
Fixes #24