Sanskriti1102/Techtalksintelligenz

Enhancement Of Contributing.md

Open

#124 opened on Oct 21, 2024

View on GitHubContributor guide
 (1 comment) (0 reactions) (1 assignee)CSS (39 forks)auto 404
gssoc-exthacktoberfestlevel1

Repository metrics

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

Description

The contributing.md file is not in a structured manner. Also some sections are missing. I can enhance it in a well structured manner with proper details and some additional sections also that will make the contributors easier to contribute. Please can you assign me this task?

Wanted to do the following changes :-

  1. Enhance the project structure
  2. Add need help with the basics section
  3. Add project structure section
  4. Add additional method of contributing through GitHub desktop section
  5. Add good coding practices section
  6. Add the help and support section
  7. Add the pull request section
  8. Add issue report process section

Contributor guide

Research direction
Read the current CONTRIBUTING.md, identify missing sections, and draft enhancements following the project's existing style and tone.
Tech stack
css
Domain
documentationdeveloper experience
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.
1-3 hours
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
GitGitHub
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
95