Skip to content
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.

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

style: add contribute page #256

Merged
merged 6 commits into from
Feb 27, 2024

Conversation

Girishbari
Copy link
Contributor

@Girishbari Girishbari commented Feb 23, 2024

Related Issue

Reference Issue #82

Description

Added contributor page with /contribute route

Screenshots

image

Copy link

vercel bot commented Feb 23, 2024

Someone is attempting to deploy a commit to a Personal Account owned by @Sanchitbajaj02 on Vercel.

@Sanchitbajaj02 first needs to authorize it.

@github-actions github-actions bot added wait for reviewers SWOC S4 Social Winter of Code (S4) 2024 contribution tag labels Feb 23, 2024
Copy link

@github-actions github-actions bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Great job, @Girishbari! 🎉 Thank you for submitting your pull request. Your contribution is valuable and we appreciate your efforts to improve our project. Keep being the part of the community!

'We will promptly review your changes and offer feedback. Keep up the excellent work!
Kindly remember to check our Contributing Guidelines'

Copy link
Contributor

coderabbitai bot commented Feb 23, 2024

Walkthrough

The update introduces a comprehensive guide for contributors to a project, detailing the process of forking and cloning a repository, setting up an Appwrite instance, and preparing a local development environment. The changes involve adding new components for each step of the contribution process, complete with visuals, interactive elements, and a tabbed interface on the contribution page for easy navigation between different sections.

Changes

File Path Change Summary
src/app/contribute/page.tsx Adds Contribute component for rendering the contribution guide.
src/components/core/contributionSections/HowToFork.tsx
src/components/core/contributionSections/HowToSetup_Appwrite.tsx
src/components/core/contributionSections/HowToSetup_dev.tsx
New components for forking/cloning, Appwrite setup, and local dev setup, with user-friendly guides.
src/components/core/contributionSections/index.tsx Exports the new contribution-related components.
src/components/pages/contribute/index.tsx Implements a new contribution page with a tabbed interface for navigating the guides.

Related issues

  • Feat: A contribution page in the application #82: The changes directly address the request for a contribution documentation page by implementing a comprehensive guide for new contributors, which aligns with the issue's objective for enhancing contributor onboarding.

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

Share

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>.
    • Generate unit-tests for this file.
  • 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 generate unit tests for this file.
    • @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 generate interesting stats about this repository from git and render them as a table.
    • @coderabbitai show all the console.log statements in this repository.
    • @coderabbitai read src/utils.ts and generate unit tests.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.

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 as PR comments)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger a review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai help to get help.

Additionally, you can add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.

CodeRabbit Configration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • The JSON schema for the configuration file is available here.
  • 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/coderabbit-overrides.v2.json

CodeRabbit Discord Community

Join our Discord Community to get help, request features, and share feedback.

Copy link
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Review Status

Actionable comments generated: 10

Configuration used: CodeRabbit UI

Commits Files that changed from the base of the PR and between 9724041 and f846f5a.
Files ignored due to path filters (25)
  • public/assets/contribute/add_origin.png is excluded by: !**/*.png
  • public/assets/contribute/add_upstream.png is excluded by: !**/*.png
  • public/assets/contribute/api-button.jpg is excluded by: !**/*.jpg
  • public/assets/contribute/api-key.jpg is excluded by: !**/*.jpg
  • public/assets/contribute/cd_pal.png is excluded by: !**/*.png
  • public/assets/contribute/clone_cli.png is excluded by: !**/*.png
  • public/assets/contribute/clone_link.png is excluded by: !**/*.png
  • public/assets/contribute/commit.png is excluded by: !**/*.png
  • public/assets/contribute/commit_detail.png is excluded by: !**/*.png
  • public/assets/contribute/copy-api.jpg is excluded by: !**/*.jpg
  • public/assets/contribute/create_branch.png is excluded by: !**/*.png
  • public/assets/contribute/fork.png is excluded by: !**/*.png
  • public/assets/contribute/hostname.jpg is excluded by: !**/*.jpg
  • public/assets/contribute/install_dep.png is excluded by: !**/*.png
  • public/assets/contribute/new-proj.jpg is excluded by: !**/*.jpg
  • public/assets/contribute/other.png is excluded by: !**/*.png
  • public/assets/contribute/proj-id.jpg is excluded by: !**/*.jpg
  • public/assets/contribute/proj-name.jpg is excluded by: !**/*.jpg
  • public/assets/contribute/proj-setting.jpg is excluded by: !**/*.jpg
  • public/assets/contribute/pull_req.png is excluded by: !**/*.png
  • public/assets/contribute/pull_upstream.png is excluded by: !**/*.png
  • public/assets/contribute/push.png is excluded by: !**/*.png
  • public/assets/contribute/scopes.jpg is excluded by: !**/*.jpg
  • public/assets/contribute/stage.png is excluded by: !**/*.png
  • public/assets/contribute/web-proj.jpg is excluded by: !**/*.jpg
Files selected for processing (6)
  • src/app/contribute/page.tsx (1 hunks)
  • src/components/core/contributionSections/HowToFork.tsx (1 hunks)
  • src/components/core/contributionSections/HowToSetup_Appwrite.tsx (1 hunks)
  • src/components/core/contributionSections/HowToSetup_dev.tsx (1 hunks)
  • src/components/core/contributionSections/index.tsx (1 hunks)
  • src/components/pages/contribute/index.tsx (1 hunks)
Files skipped from review due to trivial changes (2)
  • src/app/contribute/page.tsx
  • src/components/core/contributionSections/index.tsx

src/components/pages/contribute/index.tsx Outdated Show resolved Hide resolved
src/components/pages/contribute/index.tsx Outdated Show resolved Hide resolved
src/components/pages/contribute/index.tsx Outdated Show resolved Hide resolved
src/components/pages/contribute/index.tsx Outdated Show resolved Hide resolved
src/components/core/contributionSections/HowToFork.tsx Outdated Show resolved Hide resolved
src/components/core/contributionSections/HowToFork.tsx Outdated Show resolved Hide resolved
Copy link
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Review Status

Actionable comments generated: 0

Configuration used: CodeRabbit UI

Commits Files that changed from the base of the PR and between f846f5a and 6893344.
Files selected for processing (4)
  • src/components/core/contributionSections/HowToFork.tsx (1 hunks)
  • src/components/core/contributionSections/HowToSetup_Appwrite.tsx (1 hunks)
  • src/components/core/contributionSections/HowToSetup_dev.tsx (1 hunks)
  • src/components/pages/contribute/index.tsx (1 hunks)
Files skipped from review as they are similar to previous changes (4)
  • src/components/core/contributionSections/HowToFork.tsx
  • src/components/core/contributionSections/HowToSetup_Appwrite.tsx
  • src/components/core/contributionSections/HowToSetup_dev.tsx
  • src/components/pages/contribute/index.tsx

@Sanchitbajaj02 Sanchitbajaj02 added 🏆 good first issue Good for newcomers ⭐ enhancement Feature enhancement EASY Difficulty Level: Easy and removed wait for reviewers labels Feb 24, 2024
@Sanchitbajaj02 Sanchitbajaj02 linked an issue Feb 24, 2024 that may be closed by this pull request
2 tasks
@Sanchitbajaj02
Copy link
Owner

Hi @Girishbari

UI is not properly handled for mobile screens. Please do it

image

One more thing, use tinypng.com to compress the size of images that you have added for sample.

@Sanchitbajaj02
Copy link
Owner

image

Give a proper spacing, give atleast my-4 and make step 3 bold and increase font size

Copy link

vercel bot commented Feb 24, 2024

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

Name Status Preview Comments Updated (UTC)
palettegram ✅ Ready (Inspect) Visit Preview 💬 Add feedback Feb 24, 2024 7:36am

@Girishbari
Copy link
Contributor Author

surre

Copy link
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Review Status

Actionable comments generated: 0

Configuration used: CodeRabbit UI

Commits Files that changed from the base of the PR and between 6893344 and 4572e07.
Files selected for processing (2)
  • src/components/core/contributionSections/HowToSetup_Appwrite.tsx (1 hunks)
  • src/components/core/contributionSections/HowToSetup_dev.tsx (1 hunks)
Files skipped from review as they are similar to previous changes (2)
  • src/components/core/contributionSections/HowToSetup_Appwrite.tsx
  • src/components/core/contributionSections/HowToSetup_dev.tsx

@Girishbari
Copy link
Contributor Author

will this do for mobile
image

Copy link
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Review Status

Actionable comments generated: 0

Configuration used: CodeRabbit UI

Commits Files that changed from the base of the PR and between 4572e07 and e05789b.
Files selected for processing (1)
  • src/components/pages/contribute/index.tsx (1 hunks)
Files skipped from review as they are similar to previous changes (1)
  • src/components/pages/contribute/index.tsx

@Sanchitbajaj02 Sanchitbajaj02 merged commit 8f5d324 into Sanchitbajaj02:master Feb 27, 2024
3 of 4 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
EASY Difficulty Level: Easy ⭐ enhancement Feature enhancement 🏆 good first issue Good for newcomers SWOC S4 Social Winter of Code (S4) 2024 contribution tag
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Feat: A contribution page in the application
2 participants