smonff
commented
6 years ago Some blog posts about this could be more relevant:
- In this one replace Perl CPAN module by Github project repository and it should be self explanatory
- An example of something relatively well structured, with versions, abstract, description, etc.
- Yet another blog post from Neil Bowers that explains also how it could interact with search engines and the many tools retrieving data from Github and stuff
Those not only touch the Github metadata, but also the README file, that is the entrance room of your project. It's already a good thing you have a README, it could just be better. Also, be careful of pictures in README, they should only be a support to some more descriptive text.
Enjoy!
Hello friend Toyoto!
For a best visibility and attraction of your project in the open-source community, I would recommend to set the "topic", "description" and "website" field of your repository:
Most of the people who would search for a project like yours would have to select in a list of similar project, and if these fields are not set, it's very likely they will visit other project. Also, if they reach your project, they would surely like to understand, in a simple 1 sentence manner, how you could help them:
(exemple from Gitlab, but the idea is the same)
You did a good work since the project beginning, congratulation!