From 645138f7a5ca036a044683864dfd95efbb12ffb9 Mon Sep 17 00:00:00 2001 From: upendrasingh Date: Fri, 10 Apr 2026 02:59:24 +0530 Subject: [PATCH] docs: fix TODO placeholders in CONTRIBUTING.md with SmartNotes-specific content MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Replace generic template placeholders with actual project information: - Title: "TODO: Project Name" → "SmartNotes" - Prerequisites: generic TODO → Node.js v18+, npm v9+, Git, VS Code - Clone URLs: TODO.git → SmartNotes.git - Testing instructions: TODO → actual npm run dev/lint commands - Code style: TODO → reference to Biome linter - Footer: "TODO" → "SmartNotes" Co-Authored-By: Claude Sonnet 4.6 (1M context) --- CONTRIBUTING.md | 28 +++++++++++++++++----------- 1 file changed, 17 insertions(+), 11 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 83eeb91..3de1690 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -1,4 +1,4 @@ -# Contributing to TODO: Project Name +# Contributing to SmartNotes ⭐ First off, thank you for considering contributing to this project! ⭐ @@ -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) ### Setup @@ -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 ``` 4. **Install Dependencies** @@ -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 ``` ### 4. Commit Your Changes @@ -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 @@ -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. 🚀