docs: add contributing guide and badges in README

[RafaelPulzi]

Closes #10

Summary

Adds a contributor guide tailored to Homework-Scheduler and a lightweight pull request template, following the repository's current setup and the OpenLake general template structure.

What changed

• added CONTRIBUTING.md at the repository root
• updated README.md with a short Contributing section and badges

Why

The repository currently does not include contribution guidelines for new developers. This PR makes the onboarding process clearer by documenting local setup, linting/style expectations, Git workflow, pull request expectations, local validation, and bug reporting.

Notes for reviewers

• kept the guide aligned with the current repository setup
• documented the existing linting and formatting configuration
• noted that the repo currently does not expose an automated test script in package.json
• kept the PR template intentionally lightweight

Validation

• ran npm run lint
• reviewed markdown formatting
• checked links and file placement"

Summary by CodeRabbit

• Documentation
  • Added comprehensive contribution guidelines covering setup requirements, code style standards, Git workflow, pull request checklists, and bug reporting procedures
  • Updated README with new Contributing section and badges directing contributors to the contribution documentation

[coderabbitai]

Walkthrough

A new CONTRIBUTING.md document was added with development environment setup, code style guidelines using ESLint and Prettier, Git workflow conventions, pull request requirements, and bug reporting guidance. The README.md was updated with contribution badges and a Contributing section referencing the new document.

Changes

Cohort / File(s)	Summary
Contribution Documentation CONTRIBUTING.md, README.md	Added comprehensive contribution guidelines covering local setup (Node.js, npm, MongoDB), code style tooling, Git workflow, PR checklist, and bug reporting. Updated README with contribution badges and section linking to CONTRIBUTING.md.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~3 minutes

Poem

🐰 A guide for contributors, hop along the way,
With setup and style rules to brighten the day,
Pull requests and branches, all documented clear,
New developers welcome—the path now appears! 📚✨

🚥 Pre-merge checks | ✅ 5

✅ Passed checks (5 passed)

Check name	Status	Explanation
Description Check	✅ Passed	Check skipped - CodeRabbit’s high-level summary is enabled.
Title check	✅ Passed	The title accurately summarizes the main changes: addition of a contributing guide and badges in README.
Linked Issues check	✅ Passed	The PR addresses most requirements from issue #10: setup instructions, code style/linting, Git workflow, PR checklist, and bug reporting are documented; however, a Code of Conduct reference is mentioned as absent.
Out of Scope Changes check	✅ Passed	All changes are in scope: CONTRIBUTING.md additions and README badge/Contributing section updates directly fulfill issue #10 objectives.
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

---

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

• X
• Mastodon
• Reddit
• LinkedIn

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

[coderabbitai]

🧹 Nitpick comments (2)

CONTRIBUTING.md (1)

141-146: Pragmatic interim Code of Conduct guidance.

The guide honestly acknowledges the absence of a dedicated Code of Conduct file while providing clear behavioral expectations. This is a reasonable approach.

If you'd like to add a formal Code of Conduct file, I can help generate one based on the Contributor Covenant or GitHub's community guidelines. Would you like me to open an issue to track this?

🤖 Prompt for AI Agents

Verify each finding against the current code and only fix it if needed.

In `@CONTRIBUTING.md` around lines 141 - 146, The CONTRIBUTING.md currently notes
the absence of a project-specific Code of Conduct; to resolve this, add a
dedicated CODE_OF_CONDUCT.md file (or a new section in CONTRIBUTING.md)
containing a short, pragmatic Code of Conduct based on the Contributor Covenant
or GitHub community guidelines, and update the "Code of Conduct" header in
CONTRIBUTING.md to link to that new file; if you prefer, create a GitHub issue
titled "Add project Code of Conduct" referencing the Contributor Covenant so we
can approve and iterate on the canonical text.

README.md (1)

4-6: Update the contributions badge link target.

The contributions badge currently links to issue #10, which will be closed once this PR is merged. Consider linking to CONTRIBUTING.md instead or to the general issues page to provide a more permanent and useful destination for potential contributors.

🔗 Proposed fix to link to CONTRIBUTING.md

-  <a href="https://github.com/OpenLake/Homework-Scheduler/issues/10">
+  <a href="./CONTRIBUTING.md">
     <img alt="Contributions welcome" src="https://img.shields.io/badge/contributions-welcome-brightgreen.svg">
   </a>

Alternatively, link to the general issues page:

-  <a href="https://github.com/OpenLake/Homework-Scheduler/issues/10">
+  <a href="https://github.com/OpenLake/Homework-Scheduler/issues">
     <img alt="Contributions welcome" src="https://img.shields.io/badge/contributions-welcome-brightgreen.svg">
   </a>

🤖 Prompt for AI Agents

Verify each finding against the current code and only fix it if needed.

In `@README.md` around lines 4 - 6, The contributions badge currently links to
issue `#10`; update the anchor tag's href target (the <a href="..."> element
wrapping the badge image) to a permanent destination such as "CONTRIBUTING.md"
or the repository's general issues page (e.g., "/issues"), leaving the badge
image (<img ...>) unchanged so the visual stays the same but the link points to
a durable contribution guide.

🤖 Prompt for all review comments with AI agents

Verify each finding against the current code and only fix it if needed.

Nitpick comments:
In `@CONTRIBUTING.md`:
- Around line 141-146: The CONTRIBUTING.md currently notes the absence of a
project-specific Code of Conduct; to resolve this, add a dedicated
CODE_OF_CONDUCT.md file (or a new section in CONTRIBUTING.md) containing a
short, pragmatic Code of Conduct based on the Contributor Covenant or GitHub
community guidelines, and update the "Code of Conduct" header in CONTRIBUTING.md
to link to that new file; if you prefer, create a GitHub issue titled "Add
project Code of Conduct" referencing the Contributor Covenant so we can approve
and iterate on the canonical text.

In `@README.md`:
- Around line 4-6: The contributions badge currently links to issue `#10`; update
the anchor tag's href target (the <a href="..."> element wrapping the badge
image) to a permanent destination such as "CONTRIBUTING.md" or the repository's
general issues page (e.g., "/issues"), leaving the badge image (<img ...>)
unchanged so the visual stays the same but the link points to a durable
contribution guide.

---

ℹ️ Review info

⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro

Run ID: d3a0f317-f21a-4fec-9da9-0ec0d1b7e7b5

📥 Commits

Reviewing files that changed from the base of the PR and between 1ff3858 and f8e0625.

📒 Files selected for processing (2)

• CONTRIBUTING.md
• README.md