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

Added: Contributing.md file. #127

Merged
merged 4 commits into from
Oct 5, 2024

Conversation

rajdeepchakraborty-rc
Copy link
Contributor

Pull Request Format

Created a dedicated CONTRIBUTING.md file.

Issue #117 : [DOCS] Creation of dedicated CONTRIBUTING.md file. [SOLVED]

Type of PR

  • Add X in the box to specify the improvement type.
  • Bug fix
  • Feature enhancement
  • Documentation update
  • Other (specify): ___________

Description

This pull request aims to enhance the documentation and accessibility for contributors by providing a separate Contributing.md file, which offers a brief walkthrough to guide them in contributing to the project.

Screenshots / Videos (if applicable)

Before:

  • There was no dedicated file for contributors. Instead, the documentation for the project and the contributors was mixed within the README.md file, which reflected poor documentation practices.
    image

After:

  • This is the look of the newly added Contributing.md file.
    image
    image

Checklist

  • Add X in the box to specify.
  • I have performed a self-review of my code.
  • 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.

Additional Context

In addition to creating the Contributing.md file, I have also added a redirect link in the README.md file(Contributing Section) to guide contributors to the Contributing.md after they finish reading the README.md.

Thank you for reviewing my pull request!

Copy link

vercel bot commented Oct 5, 2024

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

Name Status Preview Comments Updated (UTC)
collect-your-gaming-tools ✅ Ready (Inspect) Visit Preview 💬 Add feedback Oct 5, 2024 1:51pm

@@ -0,0 +1,60 @@

Copy link
Owner

Choose a reason for hiding this comment

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

code is well.

Copy link
Owner

@swaraj-das swaraj-das left a comment

Choose a reason for hiding this comment

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

Merging it

@swaraj-das swaraj-das merged commit 6d70bd6 into swaraj-das:main Oct 5, 2024
2 checks passed
@rajdeepchakraborty-rc
Copy link
Contributor Author

rajdeepchakraborty-rc commented Oct 5, 2024

@swaraj-das I think you have to assign me to this PR, since the following PR is not updating on the Hacktoberfest website.
image

@sanjay-kv
Copy link

@swaraj-das
the labels using is wrong

image

kindly update this.

@swaraj-das
Copy link
Owner

@swaraj-das the labels using is wrong

image

kindly update this.

Yes sir I edited that.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants