Update README

[Yuvraj-Sarathe]

The current README.md has a lot of unnecessary comments made to hide the unnecessary blocks of code.

Removing them and writing good logic for the contributor to be shown in the readme is the fix, as currently it has just one person hardcoded in the readme.

[utkarsh232005]

there is a one more issue that when all-contributors bot add any new contributor in contributor section it addeds new all contributors section at the head of the readme

[Yuvraj-Sarathe]

I would suggest removing the bot and implementing a yml script workflow for adding contributors in readme.

[utkarsh232005]

I would suggest removing the bot and implementing a yml script workflow for adding contributors in readme.

I completely agree that the formatting issue needs to be fixed, but removing the bot to write a custom .yml workflow might add unnecessary workload. Since the all-contributors bot is already a premade, ready-to-use tool, it might be better to just adjust its configuration file (.all-contributorsrc) to fix where the section gets inserted rather than building a new script from scratch.

[Yuvraj-Sarathe]

I would suggest removing the bot and implementing a yml script workflow for adding contributors in readme.

I completely agree that the formatting issue needs to be fixed, but removing the bot to write a custom .yml workflow might add unnecessary workload. Since the all-contributors bot is already a premade, ready-to-use tool, it might be better to just adjust its configuration file (.all-contributorsrc) to fix where the section gets inserted rather than building a new script from scratch.

okay did you write the code for it or it came pre made template?

[utkarsh232005]

I would suggest removing the bot and implementing a yml script workflow for adding contributors in readme.

I completely agree that the formatting issue needs to be fixed, but removing the bot to write a custom .yml workflow might add unnecessary workload. Since the all-contributors bot is already a premade, ready-to-use tool, it might be better to just adjust its configuration file (.all-contributorsrc) to fix where the section gets inserted rather than building a new script from scratch.

okay did you write the code for it or it came pre made template?

its a marketplace github action check https://allcontributors.org/en/bot/installation/

[Yuvraj-Sarathe]

Found the issue!

The file you mentioned earlier has 2 contributors only. And they seem hardcoded; I feel this was made by the bot, and then this file is what the bot rechecks every time to update the readme.

So think of it like this: the bot changes the .all-contributorsrc file first when it detects a new contributor, and then it checks for that file to update the readme, and then it updates the readme.

But this only happens FOR EVERY NEW COMMIT! I am assuming you never committed or pushed anything after introducing the bot, or if you did commit, the bot ignored you because you were already a contributor before the bot. I and Shubham are there because we came after the bot.

This issue is one of the following 3:

• The bot ignores you because you own this repo so it doesn't recognise you as a contributor
• The bot does not account for contributors who has not committed before it being enabled and you have not committed anything since then (least likely)
• You have committed, but it does not recognize you, as it may ignore pre-existing contributors.

Checklist to pinpoint the issue:

• Confirm that you have made a commit after its addition (NOT PR MERGE BUT AN ACTUAL COMMIT FROM YOUR BRANCH); if not, then make one and see if it updates.
• If you have made a commit, see when I was added as a contributor; if it was after I made a commit, after the addition of the bot, or did it do it instantly as it was integrated

This would pinpoint exactly what is making you undetectable to the bot, and you can choose the way to resolve this.

I suggest hardcoding your details in the file and making a dummy commit by yourself to see if it adds you now.

[utkarsh232005]

Just to clarify, adding me as a contributor isn't the main issue. The real problem is that the bot keeps adding the contributor link to the header of the README.md.

We already attempted to fix this behavior in PR #16, but whenever the bot gets triggered by a new PR, it creates a pull request for adding the contributor in the readme but that breaks the header layout all over again.

[Yuvraj-Sarathe]

That we cannot fix. It is a bot error, not the file. The file is extremely hardcoded so errors like this from it do not happen. We need to disable the bot for that.

[utkarsh232005]

also in readme contributors badge you added this link "https://github.com/Yuvraj-Sarathe/kdm-website/graphs/contributors" which is misleading i suggest to fix this as this is a official repo and i am not creating new issue for this as this issue is itself stating update readme.