Skip to content

Update README.md#79

Open
jenilbanavani wants to merge 1 commit into
drkrillo:mainfrom
jenilbanavani:main
Open

Update README.md#79
jenilbanavani wants to merge 1 commit into
drkrillo:mainfrom
jenilbanavani:main

Conversation

@jenilbanavani
Copy link
Copy Markdown

No description provided.

Copy link
Copy Markdown
Owner

@drkrillo drkrillo left a comment

Choose a reason for hiding this comment

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

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.

@drkrillo
Copy link
Copy Markdown
Owner

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!

@drkrillo
Copy link
Copy Markdown
Owner

@jenilbanavani

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:

Problem

Explain breifly

Solution

Explain breifly.

Hope this helps and let me know if you have any further questions.

@jenilbanavani
Copy link
Copy Markdown
Author

@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!

@drkrillo
Copy link
Copy Markdown
Owner

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

@jenilbanavani
Copy link
Copy Markdown
Author

@drkrillo yes i'm interested!

@drkrillo
Copy link
Copy Markdown
Owner

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!

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