search

HarshCasper / Rotten-Scripts

Scripts that will make you go WOW!
MIT License
1.45k stars 494 forks source link

Improve Documentation [Important] (Read Comments) #766

Closed HarshCasper closed 2 years ago

HarshCasper commented 3 years ago

Description

Update incomplete README. As many of the Contributors might have noticed, we have a long list of Scripts along with appropriate documentation on how to launch and work with them.

Unfortunately, a lot of Scripts have been pushed without a lot of strongest checks and reviews. We can work on improving the documentation for scripts that lack a proper information.

Thanks to @avinal we now have a long list of Documentation that is not properly done or followed up. Here is a list of them:

First-Time Contributors (or even those who have landed some contributions) can take up them in batches (maybe 5-7) and raise a PR for them. As a reference take a look at our README template before you start modifying the Script. It would also be a good opportunity in finding some dead code, understanding how these scripts work and stepping up with future contributions.

vybhav72954 commented 3 years ago

@HarshCasper Can i take this one, considering I am doing the styling anyways in #762 after all the images are sorted out in the readme as mentioned in #677

I will deal with the content of the Files

HarshCasper commented 3 years ago

@HarshCasper Can i take this one, considering I am doing the styling anyways in #762 after all the images are sorted out in the readme as mentioned in #677

I will deal with the content of the Files

Sure. Please do it in batch and let me know which batch you are working on.

HarshCasper commented 3 years ago

Just as Note: Anyone can work on this! Just comment the batches that you like to work on and make a PR 😉

achalesh27022003 commented 3 years ago

Is this issue open for DWoC too?

HarshCasper commented 3 years ago

Is this issue open for DWoC too?

Yeah. Go ahead

kshittijagrawal commented 3 years ago

Hey there! I'd like to contribute to the project. I want to address and fix this issue. My implementation will be in python with a clean code and documentation. Kindly provide me with this issue. I'm also a GSSOC'21 participant.

HarshCasper commented 3 years ago

Hey there! I'd like to contribute to the project. I want to address and fix this issue. My implementation will be in python with a clean code and documentation. Kindly provide me with this issue. I'm also a GSSOC'21 participant.

Thanks for the interest!

Can you take up a batch of Scripts lacking proper documentation and make a PR for? Not much, but 5-7 of them in single batches would be good.

kshittijagrawal commented 3 years ago

Sure, I'll try my best @HarshCasper

BJSwaroop commented 3 years ago

Can I work on this @HarshCasper . As I am a beginner in coding I want to Update the Documentation.

vybhav72954 commented 3 years ago

@BJSwaroop

Hey there! I'd like to contribute to the project. I want to address and fix this issue. My implementation will be in python with a clean code and documentation. Kindly provide me with this issue. I'm also a GSSOC'21 participant.

Thanks for the interest!

Can you take up a batch of Scripts lacking proper documentation and make a PR for? Not much, but 5-7 of them in single batches would be good.

Yes you can

varshith-k commented 3 years ago

@vybhav72954 I'd like to work on few documentations, Can i?

vybhav72954 commented 3 years ago

@vybhav72954 I'd like to work on few documentations, Can i?

Yes PLease. Open a PR as soon as you have sorted out a few.

Charanjeev-2k2 commented 3 years ago

@vybhav72954 I would like to work on some of the documentations as a GSSoC participant, may I?

vybhav72954 commented 3 years ago

Sure thing. You can open a PR as soon as you can sort a few README, around 4-5 (min). Please follow the proper markdown guidelines

@vybhav72954 I would like to work on some of the documentations as a GSSoC participant, may I?

mansijain980 commented 3 years ago

@HarshCasper
image image i have a keen interest in programming python . I want to take these issues as much as i can . Please assign these to me . Thanks.

vybhav72954 commented 3 years ago

@mansijain980 The issue is open to everyone, all you need to do is, upgrade a bunch of READMEs and open a PR (Say 5-6 in one PR).

mansijain980 commented 3 years ago

Ok thanks.

sumitgsh commented 3 years ago

@HarshCasper @vybhav72954 Would love to try my hands to improve the readme. But I have one doubt like how would I figure out from the above-mentioned list which of the readme's are updated till now or is it the above list is updated one for whom no pull request is made yet.

Like suppose if someone else is working on the same readme's that I am working then I might possibly have merge conflicts

vybhav72954 commented 3 years ago

@HarshCasper @vybhav72954 Would love to try my hands to improve the readme. But I have one doubt like how would I figure out from the above-mentioned list which of the readme's are updated till now or is it the above list is updated one for whom no pull request is made yet.

Like suppose if someone else is working on the same readme's that I am working then I might possibly have merge conflicts

Hi sumit... Thanks for the interest... This is issue as we speak is going some changes (might be even closed). Kindly take up something else. Meanwhile we will discuss about the issue and will keep you posted as soon as we arrive at the proper goals and outcomes of this issue.

sumitgsh commented 3 years ago

Yah thank u..would love to know more whenever things get sorted regarding the issue..

vybhav72954 commented 3 years ago

@HarshCasper I think it's best to close this, or maybe convert it into a discussion?