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

Update README.md #69

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Update README.md #69

wants to merge 1 commit into from

Conversation

bhav09
Copy link

@bhav09 bhav09 commented Mar 22, 2021

robocomp-robolab is a very rich and diverse repository. Cheers to all the contributors and their efforts!
It is because of its vast size, it becomes a bit tedious for beginners to navigate as there many subfolders to folders. So I have thought of contributing by adding a directory tree for the components section of the repository, which would help seekers navigate and find what they are seeking, easily.

How to keep it updated?
To keep the tree updated, we can deploy a bot that would keep a track of all the modifications in the folder.

@orensbruli @Kanav-7 @adityaaggarwal97
Please review it and tell me if there are any changes that are needed. Thanks for your time and consideration.

@bhav09
Copy link
Author

bhav09 commented Mar 22, 2021

I wanted to see if maintainers find it appealing. If they do, then I would be more than happy to contribute directory trees for other folders too.

Copy link
Collaborator

@orensbruli orensbruli left a comment

Choose a reason for hiding this comment

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

It's ok for me.
The only concern is how would it be kept updated... Any suggestion?

@bhav09
Copy link
Author

bhav09 commented Mar 22, 2021

@orensbruli, it can be kept up to date by the following methods:

  1. Clone the repo and use the tree command on cmd for the respective folder to get the directory tree, copy and paste the tree into the markdown file.
  2. By manually adding the files into the markdown tree. The tree can be edited and can be updated manually.

@orensbruli
Copy link
Collaborator

2. By manually adding the files into the markdown tree. The tree can be edited and can be updated manually.

Yes, sorry. My concern is more about 'who' than 'how'. If it's now automated, as soon as any contributor adds a Component or file, this will become obsolete. Maybe a suggestion to execute the command on the local directory is better than putting it on at README?

@bhav09
Copy link
Author

bhav09 commented Mar 22, 2021

@orensbruli sir
A suggestion is to make a Github actions bot that would keep a track of all the merges/updates in the repo and as soon an update is encountered it would update the tree in the read me file itself. With this, the bot would not only automate the process to update the trees but also keep a track of all the merges that are happening to the repository.

@orensbruli
Copy link
Collaborator

It sounds great! Could you try to include this in your PR? Thank you!

@bhav09
Copy link
Author

bhav09 commented Mar 22, 2021

@orensbruli sir, I have edited the suggestion above in my first comment. Please have a look at it. Thank you :)

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

Successfully merging this pull request may close these issues.

2 participants