bsoc-bitbyte/IIITians-Space

Update readme

Open

#2 opened on Jun 2, 2023

View on GitHubContributor guide
 (3 comments) (0 reactions) (1 assignee)CSS (10 forks)auto 404
documentationgood first issuehelp wanted

Repository metrics

Stars
 (3 stars)
PR merge metrics
 (PR metrics pending)

Description

Well let's start off with this

Create a readme.md 💯

  • should include how to setup the project and run it locally
  • A few points about the project and its impact

This is created using vite, refer to package.json to checkout the scripts and update them accordingly also since each PR runs a lint and prettier:format check add that too, later will add Husky to generalize it Feel free to take inspiration from Busify's readme due to a similar tech stack and add a few points about the project how it helps out the community.

Thats about it do feel free to reach out and ask for help !!

Contributor guide

Research direction
Create a README.md file with project setup, local run instructions, and a brief description of the project's purpose and impact. Include lint and format commands from package.json.
Tech stack
javascriptvite
Domain
frontend
Issue type
Documentation
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
1
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
Under 1 hour
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
Git
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
90