Crafting a proper documentation [Contributions]

[iamyaash]

This discussion is solely focussed on crafting an effective documentation, so that the new contributors can understand without feeling overwhelmed.

Please discuss about how to create the documentation, share your thoughts and ideas, and collaborate on them.

We can also pair the participants for this task!

[jindalpriyanshu101]

@harshitpathak528

[code-killer0]

I go through many code base of different repo and one standard that I see through this all is this template is what I propose there. What else do you want to add in that.

[Wahid7852]

please share your ideas here again, it will be easier to track

[code-killer0]

1. New Contributor Guide part
2. Getting Started section
3. Issues
   3.1 Create a New Issue
   3.2 Solve an Issue
4. Making Changes
   4.1 Make Changes in the UI
   4.2 Make Changes in a Codespace
   4.3 Make Changes Locally
5. Pull Request

This is the rough idea who the page look like,
customization will we there according to your code base

[iamyaash]

Kindly avoid using GPT generated content in discussion sections!
This discussion channel was meant to share one's own ideas & thoughts, not the pre-trained GPT answers!

[softcreations01]

Proposed Title: Contribution Guidelines for Sneaky Package

Proposed Sections

1. Introduction

   • I'll highlight the importance of contributing to this project.

2. Getting Started

   • Provide well-detailed instructions on how to clone the repository and set up the development environment.
   • Also, I'll include all prerequisites needed to run this project.

3. Understanding the Codebase

   • Encourage contributors to explore the package directory.
   • I will try to suggest key features and methods to grasp how the package functions.

4. How to Contribute

   • This is my outline for the steps to take to contribute:
     • Identify an Issue: Look for open issues or propose new features.
     • Fork the Repository: Explain how to fork and clone the repo.
     • Create a Branch: Guide on creating a new branch for changes.
     • Make Changes: Tips on coding standards and best practices.
     • Testing: Encourage writing tests for new features or bug fixes.

5. Submitting Contributions

   • I will provide these instructions on how to submit a pull request and add more on suggestions:
     • Ensure that all tests pass before submitting.
     • Provide a clear description of changes made in the pull request.

6. Reporting Issues

   • Guide on how to report bugs or suggest features
   • Encourage clear and concise descriptions.

7. Acknowledgments

   • Recognize past contributors and encourage community involvement.
   • Also, I plan to include a feature that will include all contributor's photos in Readme file as a token of appreciation for their work.

[softcreations01]

Open to all suggestions, and if well impressed assign the issue to me #54

[iamyaash]

@softcreations01 seems like a good overview (needs refining)!

Alright then, start working on this, but keep in mind this documentation will go through many adjustments and you have to complete it by today EOD!

If that's okay with you leave a comment in #54
I'll assign this issue to you.

---

@jindalpriyanshu101 @Wahid7852 @ShashwatAgrawal20
Please share you thoughts on this!

[softcreations01]

You are yet to assign the issue to me, should I send my PR now