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.

Sign up for GitHub

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

Jump to bottom

[DOCS] README rewrite #41

Merged
merged 9 commits into from
Sep 14, 2023
Merged

[DOCS] README rewrite #41

merged 9 commits into from
Sep 14, 2023

Conversation

shikharish
Copy link
Member

Updated README in new format

proffapt
proffapt requested changes Sep 13, 2023
View reviewed changes
Copy link
Member

@proffapt proffapt left a comment

Choose a reason for hiding this comment

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

(back to top) sabse hatana nahi tha. Please follow the template.

@shikharish
fix: updated Maintainers sections in README
631db32 
fix: added (back to top) links
@shikharish shikharish requested a review from proffapt September 13, 2023 15:28
proffapt
proffapt requested changes Sep 13, 2023
View reviewed changes
Copy link
Member

@proffapt proffapt left a comment

Choose a reason for hiding this comment

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

Also add that additional documentation, take those docs from https://github.com/metakgp/README.md itself. As said already, stick to the template.

Also why is this metakgp wiki wala badge going to next line..
image

@harshkhandeparkar
Copy link
Member

Also why is this metakgp wiki wala badge going to next line..

It is due to the comment. Adding the license badge back will fix this.

@shikharish
Copy link
Member Author

Adding the license badge back will fix this

There is some issue in license badge. Someone please create the LICENSE file in the master branch so I can directly link it in the README

@shikharish
Copy link
Member Author

shikharish commented Sep 13, 2023 •
edited
Loading

Also add that additional documentation

Right now, additional docs would only contain LICENSE right?
Chillzone does not have any other docs mentioned in the template.

@proffapt
Copy link
Member

arey, security, issue template.. look into: https://github.com/metakgp/README.md/tree/main/.github

@harshkhandeparkar
Copy link
Member

Adding the license badge back will fix this

There is some issue in license badge. Someone please create the LICENSE file in the master branch so I can directly link it in the README

Just add the link. It will work once the pr is merged.

harshkhandeparkar
harshkhandeparkar requested changes Sep 13, 2023
View reviewed changes
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
proffapt
proffapt approved these changes Sep 14, 2023
View reviewed changes
Copy link
Member

@proffapt proffapt left a comment

Choose a reason for hiding this comment

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

LGTM.

@chirag-ghosh chirag-ghosh merged commit 1084192 into metakgp:master Sep 14, 2023
@shikharish shikharish deleted the new-readme branch September 14, 2023 18:12
@chirag-ghosh chirag-ghosh mentioned this pull request Sep 11, 2023
Open
12 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@proffapt proffapt proffapt approved these changes

@harshkhandeparkar harshkhandeparkar harshkhandeparkar approved these changes

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
4 participants
@shikharish @harshkhandeparkar @proffapt @chirag-ghosh