Skip to content

docs: fix TODO placeholders in CONTRIBUTING.md with SmartNotes-specific content #39

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
upendra512 wants to merge 1 commit into
base: main
Choose a base branch
from
Open

docs: fix TODO placeholders in CONTRIBUTING.md with SmartNotes-specific content #39

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
28 changes: 17 additions & 11 deletions CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Contributing to TODO: Project Name
# Contributing to SmartNotes

⭐ First off, thank you for considering contributing to this project! ⭐

Expand Down Expand Up @@ -56,7 +56,10 @@ Feature suggestions are welcome! Please:

### Prerequisites

TODO: List prerequisites specific to your project
- [Node.js](https://nodejs.org/) v18 or higher
- [npm](https://www.npmjs.com/) v9 or higher (comes with Node.js)
- [Git](https://git-scm.com/)
- A code editor (VS Code recommended)
Comment on lines +59 to +62
Copy link
Copy Markdown

@coderabbitai coderabbitai Bot Apr 9, 2026

Choose a reason for hiding this comment

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

⚠️ Potential issue | 🔴 Critical

🧩 Analysis chain

🏁 Script executed:

#!/bin/bash
# Description: Verify Node.js and npm version requirements in package.json

# Check for engines field in package.json
if [ -f package.json ]; then
  echo "=== Checking engines field in package.json ==="
  jq '.engines' package.json
else
  echo "package.json not found"
fi

Repository: AOSSIE-Org/SmartNotes

Length of output: 87

🏁 Script executed:

#!/bin/bash
# Find package.json anywhere in the repository
fd -t f 'package.json' .

Repository: AOSSIE-Org/SmartNotes

Length of output: 47

🏁 Script executed:

#!/bin/bash
# Check repository structure and look for configuration files
ls -la
git ls-files | head -30

Repository: AOSSIE-Org/SmartNotes

Length of output: 1635

🏁 Script executed:

#!/bin/bash
# Read CONTRIBUTING.md to understand the full context
head -100 CONTRIBUTING.md

Repository: AOSSIE-Org/SmartNotes

Length of output: 2929

🏁 Script executed:

#!/bin/bash
# Look for Node.js configuration files
fd -t f '(\.nvmrc|Dockerfile|package-lock\.json|yarn\.lock|pnpm-lock\.yaml)' .

Repository: AOSSIE-Org/SmartNotes

Length of output: 47

🏁 Script executed:

#!/bin/bash
# Check GitHub workflows to see actual build/setup process
cat .github/workflows/*.yml | grep -A 5 -B 5 'node\|npm\|install' | head -60

Repository: AOSSIE-Org/SmartNotes

Length of output: 47

🏁 Script executed:

#!/bin/bash
# Check README for project information
head -80 README.md

Repository: AOSSIE-Org/SmartNotes

Length of output: 2608

Remove or update Node.js/npm prerequisites—no package.json or Node.js configuration files exist in the repository.

The CONTRIBUTING.md prerequisites (lines 59-62) specify Node.js v18+ and npm v9+, with setup instructions referencing npm install and npm run dev. However, there is no package.json, .nvmrc, or any Node.js project configuration files in the repository. The README.md is also a template with incomplete tech stack specifications marked as TODO. Contributors following these instructions would fail immediately. Either update the prerequisites to match the actual tech stack or initialize the project with proper Node.js configuration if that is the intended direction.

🤖 Prompt for AI Agents 
Verify each finding against the current code and only fix it if needed.

In `@CONTRIBUTING.md` around lines 59 - 62, Update CONTRIBUTING.md to remove or
correct the Node.js/npm prerequisites: either (A) delete the Node.js v18+/npm
v9+ lines and any instructions mentioning `npm install`/`npm run dev`, and
instead list the actual tech stack and required tools consistent with README.md;
or (B) if Node is intended, initialize a minimal Node project (add
`package.json`, optional `.nvmrc`) and include working scripts referenced in
CONTRIBUTING.md (`install`/`dev`) so `npm install` and `npm run dev` succeed;
also reconcile README.md TODOs to reflect whichever option you choose.


### Setup

Expand All @@ -67,13 +70,13 @@ TODO: List prerequisites specific to your project

2. **Clone Your Fork**
```bash
git clone https://github.com/YOUR_USERNAME/TODO.git
cd TODO
git clone https://github.com/YOUR_USERNAME/SmartNotes.git
cd SmartNotes
```

3. **Add Upstream Remote**
```bash
git remote add upstream https://github.com/AOSSIE-Org/TODO.git
git remote add upstream https://github.com/AOSSIE-Org/SmartNotes.git
Comment on lines 77 to +79
Copy link
Copy Markdown

@coderabbitai coderabbitai Bot Apr 9, 2026

Choose a reason for hiding this comment

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

⚠️ Potential issue | 🟡 Minor

Add blank line before code block.

There should be a blank line between the section header and the fenced code block to comply with markdown best practices.

📝 Proposed fix 
 3. **Add Upstream Remote**
+
    ```bash
    git remote add upstream https://github.com/AOSSIE-Org/SmartNotes.git

As per coding guidelines, fenced code blocks should be surrounded by blank lines (markdownlint MD031).

📝 Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.

Suggested change
3. **Add Upstream Remote**
```bash
git remote add upstream https://github.com/AOSSIE-Org/TODO.git
git remote add upstream https://github.com/AOSSIE-Org/SmartNotes.git
3. **Add Upstream Remote**
🧰 Tools
🪛 markdownlint-cli2 (0.22.0)

[warning] 78-78: Fenced code blocks should be surrounded by blank lines

(MD031, blanks-around-fences)

🤖 Prompt for AI Agents 
Verify each finding against the current code and only fix it if needed.

In `@CONTRIBUTING.md` around lines 77 - 79, Add a blank line between the section
header "3. **Add Upstream Remote**" and the fenced code block that contains the
git command so the markdown has an empty line before the ```bash block; update
the CONTRIBUTING.md around the Add Upstream Remote section to insert that single
blank line above the code fence to satisfy markdownlint MD031.

```

4. **Install Dependencies**
Expand Down Expand Up @@ -109,12 +112,15 @@ git checkout -b fix/your-bug-fix

### 3. Test Your Changes

TODO: Add project-specific testing instructions

```bash
npm test
# or
# Run linter
npm run lint

# Check formatting
npm run format

# Run the app in development mode to test your changes
npm run dev
Comment on lines +116 to +123
Copy link
Copy Markdown

@coderabbitai coderabbitai Bot Apr 9, 2026

Choose a reason for hiding this comment

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

⚠️ Potential issue | 🔴 Critical

🧩 Analysis chain

🏁 Script executed:

#!/bin/bash
# Description: Verify the npm scripts mentioned in the testing instructions exist

# Check for scripts in package.json
if [ -f package.json ]; then
  echo "=== Checking for npm scripts ==="
  jq '.scripts | {lint, format, dev}' package.json
else
  echo "package.json not found"
fi

Repository: AOSSIE-Org/SmartNotes

Length of output: 87

🏁 Script executed:

#!/bin/bash
# Search for package.json files anywhere in the repo
echo "=== Searching for package.json files ==="
fd -t f "package.json" 2>/dev/null || find . -name "package.json" -type f 2>/dev/null

# Check for other package manager files
echo ""
echo "=== Looking for other package manager indicators ==="
fd -t f -e lock.json -e lock.yaml -e lock.yml 2>/dev/null | grep -E "(package-lock|yarn|pnpm)" || echo "No lock files found"

# Check repository root structure
echo ""
echo "=== Repository root files ==="
ls -la | head -20

Repository: AOSSIE-Org/SmartNotes

Length of output: 1023

🏁 Script executed:

#!/bin/bash
# Read CONTRIBUTING.md to see the full context around lines 116-123
echo "=== Full CONTRIBUTING.md content ==="
cat -n CONTRIBUTING.md

Repository: AOSSIE-Org/SmartNotes

Length of output: 8638

🏁 Script executed:

#!/bin/bash
# Check if package.json is gitignored
echo "=== Checking .gitignore for package.json patterns ==="
grep -n "package.json" .gitignore || echo "package.json not found in .gitignore"

echo ""
echo "=== Checking for any build/dist related patterns ==="
grep -E "(dist|build|node_modules)" .gitignore | head -10

Repository: AOSSIE-Org/SmartNotes

Length of output: 209

Remove npm instructions from CONTRIBUTING.md or provide the missing package.json file.

The testing instructions on lines 116-123 reference npm run lint, npm run format, and npm run dev, but the repository contains no package.json file or npm infrastructure. This creates a broken setup flow—contributors following the Prerequisites (Node.js v18+, npm v9+) and Setup steps (npm install) will fail immediately. Either add the missing package.json and related npm configuration files, or remove the npm-based instructions from this guide.

🤖 Prompt for AI Agents 
Verify each finding against the current code and only fix it if needed.

In `@CONTRIBUTING.md` around lines 116 - 123, The CONTRIBUTING.md references npm
commands ("npm run lint", "npm run format", "npm run dev") but the repo lacks a
package.json so the setup is broken; either remove those npm instructions from
CONTRIBUTING.md or add a package.json that defines scripts "lint", "format", and
"dev" plus any required devDependencies and a basic "install" workflow so "npm
install" succeeds; ensure the README/Prerequisites section is updated to match
(remove npm requirements if you delete the commands, or keep Node/npm versions
and add the package.json if you add scripts).

```

### 4. Commit Your Changes
Expand Down Expand Up @@ -204,7 +210,7 @@ Steps to test the changes

## 📝 Code Style Guidelines

TODO: Add project-specific code style guidelines
SmartNotes uses [Biome](https://biomejs.dev/) for linting and formatting. Run `npm run lint` before committing.

### General Guidelines

Expand Down Expand Up @@ -255,4 +261,4 @@ TODO: Add project-specific code style guidelines
- Check for existing PRs before starting to avoid duplication


Thank you for contributing to TODO! Your efforts help make this project better for everyone. 🚀
Thank you for contributing to SmartNotes! Your efforts help make this project better for everyone. 🚀
Loading