Update README.md#79
Conversation
drkrillo
left a comment
There was a problem hiding this comment.
The message is great!
The problem is that this modifies README.md directly, instead of the template.
The template/README.md.j2 is used daily to update README.md with a GitHub Actions woorkflow, which means README.md is replaced every day.
This message should be in that template, so that when it is used for updating the README.md, it propagates correctly.
If not, this README.md will get replaced the next day by the template, which doesn't have the message.
|
I would also leave the comment above the table or even higher in the readme template, if this makes sense . This way, more contributors will see it. Thanks for contributing! |
|
Let me know if you have any questions on why to do it this way. Also, it is a good idea to give a description to the PR explaining how and why you are making this PR. Nothing too long, but can help understanding what was modified. A good message (at least for this repo) is: ProblemExplain breifly SolutionExplain breifly. Hope this helps and let me know if you have any further questions. |
|
@drkrillo Thanks for the explanation! I understand the workflow better now. I’ll move the change to template/README.md.j2 and update the PR description accordingly. Appreciate the guidance! |
|
Hi @jenilbanavani ! Are you still interested in making the PR ? There is another PR trying to solve the same issue, but I wanted to give you priority since you opened it first . Let me know ! Thank you |
|
@drkrillo yes i'm interested! |
|
Hey @jenilbanavani ! Perfect, I am happy to hear that :) The idea is helping you out with this. So please let me know if there is something you don't undesrstand, or you need further guidance. No need to rush into the solutions, I didn't want to sound like that. But have in mind I want to help you if you need it . Just let me know! |
No description provided.