File Review Tool (#46)

Add file review tool

Author: chienyuanchang

tools/review_file/.env.sample

@@ -0,0 +1,25 @@
+# Azure OpenAI resource endpoint (no trailing slash)
+AZURE_OPENAI_ENDPOINT="<YOUR_AZURE_OPENAI_ENDPOINT>"
+
+# Deployment name you configured in Azure OpenAI
+AZURE_OPENAI_DEPLOYMENT="<YOUR_AZURE_OPENAI_DEPLOYMENT_NAME>"
+
+# GitHub Personal Access Token (with repo permissions)
+GITHUB_TOKEN="<YOUR_GITHUB_PERSONAL_ACCESS_TOKEN>"
+
+# GitHub repository in 'owner/repo' format
+GITHUB_REPOSITORY="<OWNER/REPO>"
+
+# File path in the repo you want to review
+INPUT_FILE_PATH="<PATH/TO/INPUT_FILE>"
+
+# (Optional) Name of the branch to review or submit changes to
+# Defaults to the default branch of the repository if not set
+BRANCH_NAME="<YOUR_TARGET_BRANCH_NAME>"
+
+# (Optional) Additional reviewer instructions to guide the LLM
+USER_INSTRUCTIONS="<YOUR_OPTIONAL_REVIEW_INSTRUCTIONS>"
+
+# (Optional) Whether to use LLM to review changes and submit comments, true/false
+# Defaults to true if not set
+ENABLE_REVIEW_CHANGES=true

tools/review_file/README.md

@@ -0,0 +1,49 @@
+# review_file.py
+
+## Automated Documentation & Code Review
+
+The `review_file.py` script uses Azure OpenAI and GitHub APIs to automatically review and improve documentation or code files, then creates a pull request with suggested changes. It also analyzes diffs and leaves section-level comments on PRs.
+
+### Usage
+
+1. **Set Required Environment Variables**  
+   you can copy `tools/.env.sample` to `tools/.env`
+   Ensure the following environment variables are set in your [.env](../tools/.env) file under `/tools`:
+   - `AZURE_OPENAI_ENDPOINT`
+   - `AZURE_OPENAI_DEPLOYMENT`
+   - `GITHUB_TOKEN`
+   - `GITHUB_REPOSITORY`
+   - `INPUT_FILE_PATH`
+   - Optional:
+      - `BRANCH_NAME` (default: default branch such as `main`)
+      - `USER_INSTRUCTIONS`
+      - `ENABLE_REVIEW_CHANGES` (default: `true`)
+   
+   **💡 Tips for Setting Up `GITHUB_TOKEN`:**
+   - Go to [https://github.com/settings/tokens](https://github.com/settings/tokens) and click **"Generate new token (Classic)"**.
+   - Select the following scopes when generating the token:
+     - ✅ `repo` – Full control of private repositories
+   - If the repository belongs to an organization, make sure:
+     - You are a **collaborator** or a **member with write access**.
+     - The organization allows use of classic tokens.
+
+2. **Install Dependencies**  
+   ```bash
+   pip3 install azure-identity python-dotenv PyGithub openai unidiff requests
+   ```
+
+3. **Run the Script**  
+   ```bash
+   python3 tools/review_file.py
+   ```
+   This will:
+   - Review the file specified by `INPUT_FILE_PATH` using LLM.
+   - Create a new branch and commit the revised file.
+   - Open a pull request with the changes.
+   - Optionally, analyze the diff and comment on changed sections.
+
+### Notes
+
+- The script is intended for documentation files (e.g., `README.md`) and code comments.
+- Ensure your Azure OpenAI and GitHub credentials are valid.
+- Comments on PRs are generated using LLM for clarity and rationale.