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

Create readme.md #303

Merged
merged 7 commits into from
Jul 16, 2024
Merged

Create readme.md #303

merged 7 commits into from
Jul 16, 2024

Conversation

1754riya
Copy link
Contributor

@1754riya 1754riya commented Jul 16, 2024

Related Issue

closes #279
[Cite any related issue(s) this pull request addresses. If none, simply state "None”]
write issue no. here

Email id used to regsiter for VSoc'24

rmehta1754@gmail.com

Description

[Please include a brief description of the changes or features added]

Type of PR

  • Bug fix
  • Feature enhancement
  • Documentation update
  • Security enhancement
  • Other (specify): _______________

check in issue by entering [X] in boxes

Screenshots / Videos (if applicable)

[Attach any relevant screenshots or videos demonstrating the changes]

Checklist

  • I have performed a self-review of my code.
  • I have read and followed the Contribution Guidelines.
  • I have tested the changes thoroughly before submitting this pull request.
  • I have provided relevant issue numbers, screenshots, and videos after making the changes.
  • I have commented my code, particularly in hard-to-understand areas.
  • I have followed the code style guidelines of this project.
  • I have checked for any existing open issues that my pull request may address.
  • I have ensured that my changes do not break any existing functionality.
  • Each contributor is allowed to create a maximum of 4 issues per day. This helps us manage and address issues efficiently.
  • I have read the resources for guidance listed below.
  • I have followed security best practices in my code changes.

check in issue by entering [X] in boxes

Additional Context

[Include any additional information or context that might be helpful for reviewers.]

Contribution Guidelines

Thank you for considering contributing to our project! To ensure smooth collaboration and effective contribution management, please adhere to the following guidelines:

Issue Creation

  1. Limit on Issues:
    • Each contributor is allowed to create a maximum of 4 issues per day. This helps us manage and address issues efficiently.

Contribution Levels

  1. Basic Contributions:

    • This project is primarily focused on documentation. Most of the setup has been completed, so contributors will generally need to work on basic code tasks, such as writing tests.
    • For these tasks, issues will be assigned the Easy label.
  2. Acknowledging Hard Work:

    • If a contributor puts in significant effort on a task, the issue will be upgraded to Medium. This is our way of recognizing and appreciating extra effort.
  3. Feature Additions and Component Work:

    • Contributors working on new features or components using JSX/TSX will be assigned a level based on the complexity and quality of their work.
    • The more complex and valuable the contribution, the higher the level assigned.

Level Definitions

  • Easy:
    • Tasks are straightforward, such as fixing minor bugs, writing tests, or making simple documentation updates.
  • Medium:
    • Tasks require more effort, such as addressing complex bugs, improving existing features, or making substantial documentation improvements.
  • Hard:
    • Tasks are highly complex and involve significant new feature development, major refactoring, or extensive contributions to the project’s core components.

We look forward to your contributions and appreciate your effort in helping us improve the project!

Copy link
Contributor

Thank you for submitting your pull request! 🙌 We'll review it as soon as possible. In the meantime, please ensure that your changes align with our CONTRIBUTING.md. If there are any specific instructions or feedback regarding your PR, we'll provide them here. Thanks again for your contribution! 😊

Copy link

vercel bot commented Jul 16, 2024

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

Name Status Preview Comments Updated (UTC)
50-days-50-web-project ✅ Ready (Inspect) Visit Preview 💬 Add feedback Jul 16, 2024 2:38pm

Copy link
Owner

@dhairyagothi dhairyagothi left a comment

Choose a reason for hiding this comment

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

goood @1754riya

@dhairyagothi dhairyagothi added documentation Improvements or additions to documentation VSoC'24 contribution under VSOC 24 HARD Urgent labels Jul 16, 2024
@dhairyagothi dhairyagothi merged commit e2f96e1 into dhairyagothi:Main Jul 16, 2024
2 checks passed
Copy link
Contributor

🎉 Your pull request has been successfully merged! 🎉 Thank you for your valuable contribution to our project. Your efforts are greatly appreciated. Feel free to reach out if you have any more contributions or if there's anything else we can assist you with. Keep up the fantastic work! 🚀

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation HARD Urgent VSoC'24 contribution under VSOC 24
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Add README.md to backend projects and adding link in index.html
2 participants