feat: add links and guidelines for contributing

[dtczelo]

close #44

Standard contributing guidelines, let me know if you want to improve

Summary by CodeRabbit

• New Features

  • Added a "Want to contribute?" call-to-action with a link to the GitHub repository in the footer.
  • Introduced a CONTRIBUTING guide to help new contributors get started.

• Documentation

  • Added a "Contribute" section to the README with information and links for contributing.
  • Created a CONTRIBUTING.md file outlining steps for contributing to the project.

[vercel]

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name	Status	Preview	Comments	Updated (UTC)
gnolove	✅ Ready (Inspect)	Visit Preview	💬 Add feedback	Jul 31, 2025 9:28am

[coderabbitai]

Walkthrough

A new CONTRIBUTING.md file was introduced to guide contributors, and a "Contribute" section was added to the README. The footer component was updated to display a horizontal layout with an additional call-to-action link inviting users to contribute, including a direct link to the GitHub repository.

Changes

Cohort / File(s)	Change Summary
Contribution Documentation CONTRIBUTING.md, README.md	Added a new contribution guide and a "Contribute" section in the README with a link to the guide and repository.
Footer Component Update src/components/modules/footer.tsx	Modified the footer to a horizontal layout and added a "Want to contribute?" call-to-action with a GitHub link.

Sequence Diagram(s)

sequenceDiagram
  participant User
  participant Footer
  participant GitHub

  User->>Footer: View footer section
  Footer-->>User: Display attribution and "Want to contribute?" link
  User->>Footer: Click "Want to contribute?" link
  Footer->>GitHub: Redirect to repository page

Loading

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~7 minutes

Assessment against linked issues

Objective	Addressed	Explanation
Add a link to the repo on the page to invite people to edit/improve (#44)	✅

Poem

In the footer now, a link shines bright,
"Want to contribute?"—a welcome sight!
With guides and docs, our path is clear,
To GitHub’s warren, hop with cheer.
🐇✨ Let’s build together, side by side—
In open code, we take great pride!

Note

⚡️ Unit Test Generation is now available in beta!

Learn more here, or try it out under "Finishing Touches" below.

---

📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between a4fe0cb and 16a8104.

📒 Files selected for processing (1)

• README.md (1 hunks)

🚧 Files skipped from review as they are similar to previous changes (1)

• README.md

✨ Finishing Touches

🧪 Generate unit tests

• Create PR with unit tests
• Post copyable unit tests in a comment
• Commit unit tests in branch feat/contributing-to-gnolove

---

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

🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

• Review comments: Directly reply to a review comment made by CodeRabbit. Example:
  • I pushed a fix in commit <commit_id>, please review it.
  • Explain this complex logic.
  • Open a follow-up GitHub issue for this discussion.
• Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
  • @coderabbitai explain this code block.
  • @coderabbitai modularize this function.
• PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
  • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
  • @coderabbitai read src/utils.ts and explain its main purpose.
  • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
  • @coderabbitai help me debug CodeRabbit configuration file.

Support

Need help? Create a ticket on our support page for assistance with any issues or questions.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

• @coderabbitai pause to pause the reviews on a PR.
• @coderabbitai resume to resume the paused reviews.
• @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
• @coderabbitai full review to do a full review from scratch and review all the files again.
• @coderabbitai summary to regenerate the summary of the PR.
• @coderabbitai generate docstrings to generate docstrings for this PR.
• @coderabbitai generate sequence diagram to generate a sequence diagram of the changes in this PR.
• @coderabbitai generate unit tests to generate unit tests for this PR.
• @coderabbitai resolve resolve all the CodeRabbit review comments.
• @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
• @coderabbitai help to get help.

Other keywords and placeholders

• Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
• Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
• Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

• You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
• Please see the configuration documentation for more information.
• If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

• Visit our Documentation for detailed information on how to use CodeRabbit.
• Join our Discord Community to get help, request features, and share feedback.
• Follow us on X/Twitter for updates and announcements.

[coderabbitai]

Actionable comments posted: 1

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 3b7f9c4 and a4fe0cb.

📒 Files selected for processing (3)

• CONTRIBUTING.md (1 hunks)
• README.md (1 hunks)
• src/components/modules/footer.tsx (1 hunks)

🔇 Additional comments (2)

CONTRIBUTING.md (1)

1-21: LGTM! Clear and comprehensive contribution guide.

The CONTRIBUTING.md file provides excellent guidance for new contributors with clear step-by-step instructions and appropriate Git command examples. The structure and content align perfectly with the PR objectives.

src/components/modules/footer.tsx (1)

39-57: LGTM! Well-structured footer enhancement.

The refactoring from a single vertical layout to a horizontal layout with two distinct sections is well-implemented. The code follows React/Next.js best practices, uses consistent Radix UI components, and the new contribution call-to-action effectively supports the PR objectives of encouraging community involvement.