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

Improve main README.md. Add link to the programs 😽 #13

Closed
mpotane opened this issue Oct 11, 2022 · 14 comments · Fixed by #15
Closed

Improve main README.md. Add link to the programs 😽 #13

mpotane opened this issue Oct 11, 2022 · 14 comments · Fixed by #15
Assignees
Labels
documentation Improvements or additions to documentation good first issue Good for newcomers

Comments

@mpotane
Copy link
Owner

mpotane commented Oct 11, 2022

Example:

@mpotane mpotane added enhancement New feature or request good first issue Good for newcomers hacktoberfest labels Oct 11, 2022
@mpotane mpotane changed the title Improve main REAME.md. Add link to the programs 😽 Improve main README.md. Add link to the programs 😽 Oct 11, 2022
@Vishvam10
Copy link
Contributor

I can do it. Please assign the task to me.

@mpotane
Copy link
Owner Author

mpotane commented Oct 11, 2022

I can do it. Please assign the task to me.

Nice bro i'll do that in a sec.

@mpotane mpotane pinned this issue Oct 11, 2022
@Lakshayainani
Copy link

Lakshayainani commented Oct 11, 2022

@mpotane Can I give it a try ?
I'm new to github contributions.

PR: #14

@mpotane mpotane linked a pull request Oct 11, 2022 that will close this issue
@Lakshayainani
Copy link

@mpotane Anymore changes required for this issue?

@mpotane
Copy link
Owner Author

mpotane commented Oct 11, 2022

@mpotane Can I give it a try ? I'm new to github contributions.

PR: #14

Let's wait @Vishvam10 a lil bit more

@Lakshayainani
Copy link

@mpotane Any suggestions on how to get started and contribute more?

@mpotane
Copy link
Owner Author

mpotane commented Oct 11, 2022

@mpotane Any suggestions on how to get started and contribute more?

check #5 out

@Vishvam10
Copy link
Contributor

I'm almost done with it. I just wrote a small script to get all the folders and its link. Do you want me to commit the script as well ? If so, I would like to improve it. It's pretty basic at the moment.

@mpotane
Copy link
Owner Author

mpotane commented Oct 11, 2022

I'm almost done with it. I just wrote a small script to get all the folders and its link. Do you want me to commit the script as well ? If so, I would like to improve it. It's pretty basic at the moment.

you can add new script, I will check and review the code. But your open PR needs to be merged first.

@Vishvam10
Copy link
Contributor

Cool. I'll submit the updated README now. I'm new to this, should I open a new PR or an issue for the script ?

@mpotane
Copy link
Owner Author

mpotane commented Oct 11, 2022

Cool. I'll submit the updated README now. I'm new to this, should I open a new PR or an issue for the script ?

yep you can submit your PR now. If yours turn out to be okay, i'll mark the other one duplicate.

@mpotane mpotane added documentation Improvements or additions to documentation and removed enhancement New feature or request labels Oct 11, 2022
@Vishvam10
Copy link
Contributor

Vishvam10 commented Oct 11, 2022

I submitted the PR for the README file. I have a few doubts regarding the scripts. Say the folder structure was something like this :

  • Parent_Folder_1
    • Sub_Folder_1
    • Sub_Folder_2
    • ...
  • Parent_Folder_2
  • ...

Should the README contain nested links in the following fashion :

Or should it just have the link for the Parent_Folders ?

@mpotane mpotane linked a pull request Oct 11, 2022 that will close this issue
@mpotane mpotane unpinned this issue Oct 11, 2022
@mpotane
Copy link
Owner Author

mpotane commented Oct 11, 2022

I submitted the PR for the README file. I have a few doubts regarding the scripts. Say the folder structure was something like this :

  • Parent_Folder_1

    • Sub_Folder_1
    • Sub_Folder_2
    • ...
  • Parent_Folder_2

  • ...

Should the README contain nested links in the following fashion :

Or should it just have the link for the Parent_Folders ?

We can open a new issue so more can PR in hacktoberfest

@Vishvam10
Copy link
Contributor

Cool. I'll probably include that as a flag. I'll develop a CLI to dynamically update the readme with new links whenever a new folder is found. Should I proceed with this ? And if I can, should I create a new folder named "Scripts" to have all these files ?

One last thing, I've registered to hacktoberfest as a code contributor. So the readme pr won't count right ? And if the CLI part looks good and I develop it, would that be counted ?

I'm new to this and any help / guidance would be greatly appreciated !

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation good first issue Good for newcomers
Projects
None yet
Development

Successfully merging a pull request may close this issue.

3 participants