Skip to content

Improve contributing guide with testing section and formatting #1069

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
Avinash-sdbegin wants to merge 1 commit into
base: master
Choose a base branch
from
+12 −0
Open

Improve contributing guide with testing section and formatting #1069

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
12 changes: 12 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -65,6 +65,7 @@ notesvault/

Simply open `index.html` in your browser. All data is stored locally via JSON or localStorage.


3. **Develop and test**

- Edit `notes.json` to simulate new data
Expand All @@ -73,6 +74,17 @@ Simply open `index.html` in your browser. All data is stored locally via JSON or

---

## ▶️ How to Run Locally

Follow these steps to run the project on your system:

1. Clone the repository
2. Navigate to the project folder
3. Open `index.html` in any modern browser (Chrome/Edge/Firefox)
4. Start exploring NotesVault

No additional setup or installation is required.

## 🧑‍💻 Contributing

We welcome all kinds of contributions, especially from beginners! Since the project is in early stages, **you can help build core features from scratch**.
Expand Down