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

Documentation Chaos: #177

Closed
5 tasks done
milansamuel609 opened this issue Oct 25, 2024 · 5 comments · Fixed by #181
Closed
5 tasks done

Documentation Chaos: #177

milansamuel609 opened this issue Oct 25, 2024 · 5 comments · Fixed by #181
Assignees
Labels
chaos Chaotic update documentation Improvements or additions to documentation gssoc-ext GSSOC'24 Extd Participant hacktoberfest-accepted hacktoberfest accepted level1 awards 10 points

Comments

@milansamuel609
Copy link
Contributor

Describe the Documentation Update

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.

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

Add References or Examples

No response

Confirm

  • I understand that my update will add to the chaos and I'm okay with it
  • I agree to follow this project's Code of Conduct
  • I want to work on this documentation update
  • I'm GSSOC'24 Extd registered Contributor
  • I'm Hacktoberfest registered Contributor
@milansamuel609 milansamuel609 added chaos Chaotic update documentation Improvements or additions to documentation labels Oct 25, 2024
Copy link

👋 Hey @milansamuel609! Thanks for stepping into the chaos and opening an issue in the ChaosWeb project. We embrace disorder, and your contribution adds to the delightful mess! 🎉
Welcome to the wild side of web design. Expect the unexpected! 🌍🌀

Copy link

👋 Hey @milansamuel609! Thanks for opening an issue in the ChaosWeb project. We’re excited to see how you’ve contributed to the delightful mess. Our team will review it soon. Stay chaotic! 🎯

@vansh-codes
Copy link
Owner

Go ahead!
Make all the changes in CONTRIBUTING.md file and not in README

@vansh-codes vansh-codes added gssoc-ext GSSOC'24 Extd Participant level1 awards 10 points hacktoberfest-accepted hacktoberfest accepted labels Oct 25, 2024
@milansamuel609
Copy link
Contributor Author

Go ahead! Make all the changes in CONTRIBUTING.md file and not in README

Sure 👍

Copy link

Hello @milansamuel609! Your chaotic issue #177 has been closed. Thank you for your contribution!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
chaos Chaotic update documentation Improvements or additions to documentation gssoc-ext GSSOC'24 Extd Participant hacktoberfest-accepted hacktoberfest accepted level1 awards 10 points
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants