This looks good and I love the idea, here's my feedback:
To get people attracted to your repo I think having a good README is a good start, Let people know what is it about and how they can contribute/run and test the project locally.
Mentioned that Contribution is always welcome
Marks the easy issues as first-good-issue or help-wanted and add more details I would even point to some code where to start
I would start writing an introduction with the state of art. Why you started the project, if there is any others projects doing the same. A small diagram of the technologies that you are using/architect.
Of course in README.md at least how to start the project locally and a small explanation to new developers.
Reading what it's there didn't make me understand exactly what's all this about.
Hey Jonathan,
This looks good and I love the idea, here's my feedback:
To get people attracted to your repo I think having a good README is a good start, Let people know what is it about and how they can contribute/run and test the project locally.
Mentioned that Contribution is always welcome
Marks the easy issues as first-good-issue or help-wanted and add more details I would even point to some code where to start
Totally agree. Adding a wiki could be also useful. Some screenshots too.
Wiki added. What kind of pages do you think I should have?
I would start writing an introduction with the state of art. Why you started the project, if there is any others projects doing the same. A small diagram of the technologies that you are using/architect.
Of course in README.md at least how to start the project locally and a small explanation to new developers.
Reading what it's there didn't make me understand exactly what's all this about.
Just my opinion. I hope my feedback helps you.
Thank you! I've been looking for feedback on where to start. What is my README missing?
the First thing a README IMO is a clear sentence (TL;DR version) what is the repo about.
After that a table of content for easy navigation.
Sections can be :
for CONTRIBUTION.md you get some inspiration from famous repos, it's basically a spec document on how to run tests, add PR, code style and so on