Skip to content

Improve contributing guide with testing section and formatting#1069

Open
Avinash-sdbegin wants to merge 1 commit intoopensource-society:masterfrom
Avinash-sdbegin:fix-branch-name
Open

Improve contributing guide with testing section and formatting#1069
Avinash-sdbegin wants to merge 1 commit intoopensource-society:masterfrom
Avinash-sdbegin:fix-branch-name

Conversation

@Avinash-sdbegin
Copy link
Contributor

@Avinash-sdbegin Avinash-sdbegin commented Feb 5, 2026

Summary

  • Added a "Testing Your Changes" section to help contributors verify their work
  • Improved step order and formatting in the contributing guide
  • Cleaned up markdown structure for better readability

Impact

These changes make it easier for new contributors to understand the workflow and submit high-quality pull requests.

Summary by CodeRabbit

  • Documentation
    • Added "How to Run Locally" guide with simple setup steps—no additional dependencies required to get started.

@coderabbitai
Copy link

coderabbitai bot commented Feb 5, 2026

📝 Walkthrough

Walkthrough

A "How to Run Locally" section has been added to README.md, providing step-by-step instructions for users to clone the repository, navigate to the project folder, open index.html in a browser, and start using NotesVault with a note that no additional setup is required.

Changes

Cohort / File(s) Summary
Documentation
README.md
Added "How to Run Locally" section under Getting Started with local setup instructions and browser launch steps.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~3 minutes

Poem

🐰 A guide for wanderers seeking the vault,
Just clone and open, no setup fault!
In your browser, let NotesVault shine,
Simple instructions, step by line. ✨📝

🚥 Pre-merge checks | ✅ 2 | ❌ 1
❌ Failed checks (1 warning)
Check name Status Explanation Resolution
Title check ⚠️ Warning The PR title mentions 'contributing guide with testing section' but the actual changes only add 'How to Run Locally' instructions to README.md, with no testing section or contributing guide changes. Update the PR title to accurately reflect the actual changes, such as 'Add local run instructions to README' or 'Improve README with local setup guidance'.
✅ Passed checks (2 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Post copyable unit tests in a comment

Comment @coderabbitai help to get the list of available commands and usage tips.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant