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

Add Pomolectron's README. #50

Closed

Conversation

amitmerchant1990
Copy link
Contributor

No description provided.

@RichardLitt
Copy link
Contributor

Can I contribute to it?

@amitmerchant1990
Copy link
Contributor Author

@RichardLitt Yes. That goes without saying. 👍

@RichardLitt
Copy link
Contributor

That goes without saying.

It doesn't! 😅 Add a Contribute section then!

@amitmerchant1990
Copy link
Contributor Author

@RichardLitt Is it necessary for this list?

@RichardLitt
Copy link
Contributor

Not specifically, no. But if the Readme can be easily made more useful, why not?

I'd personally argue that it's not awesome without one, mostly because it doesn't advertise to others that the project is open to collaborations.

@amitmerchant1990
Copy link
Contributor Author

amitmerchant1990 commented Oct 3, 2017

@RichardLitt Okay. I'll surely add one once I draft it specifically for my project. For now, can we merge and close it if no issue is there apart from this?

@RichardLitt
Copy link
Contributor

Unfortunately, I'm not sure I should. I had a question after reading your README, which means it didn't answer all of my concerns. That's not ideal.

More abstractly, this PR has made me wonder what makes an awesome README a bit more than the other more recent PRs have. There are a ton of great READMEs in this list, but they are all starting to look the same to me, and I suspect people are using the list as an advertisement scheme for themselves instead of as a way to point out ridiculously good documentation.

At the moment, I've seen too many README's to make yours seem awesome to me. Which means I am going to recuse myself from judgement here.

There are some procedural changes we could put in place to stop this: for instance, asking that PRs get a +1 from a non-contributor before merging, or disabling self-submissions. Another would be having submitters explain why their README is more awesome than others on the list, as a way of judging fitness. I'd be open to these.

@matiassingers What do you think?

@amitmerchant1990
Copy link
Contributor Author

@RichardLitt I respect your opinion about this but at the same time you can see it's also truth that there's no mention of adding contributing.md in this project's(awesome-readme) contributing.md. If there would have been written any such rule, I'd not have opened the pull request. Do you agree with me?

@RichardLitt
Copy link
Contributor

Sure. But there also isn't a rule about anything else. It's up to the maintainers - me.

Currently, I do not think your README is awesome.

@amitmerchant1990
Copy link
Contributor Author

What do I need to do in order to make it awesome? I think I've included all the necessary information regarding this particular app and also the related details. What am I missing?

@RichardLitt
Copy link
Contributor

Well, for one, a Contribute section would be good.

We need to come to a resolution about #51. I may not be a good judge at the moment, as your README doesn't strike me as awesome. Ultimately, there's no checklist I can point you to to fill out to make your README awesome - it's a subjective opinion.

@amitmerchant1990
Copy link
Contributor Author

Thanks.

@RichardLitt
Copy link
Contributor

Sorry for being a stickler, here. I'm just trying to make sure that the content is all really awesome.

@amitmerchant1990
Copy link
Contributor Author

No problem mate. I understood.

Repository owner deleted a comment Jun 22, 2022
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