Skip to content

Latest commit

 

History

History
17 lines (12 loc) · 1.04 KB

README.md

File metadata and controls

17 lines (12 loc) · 1.04 KB

chicken-egg

There are many good open source projects start but don't get much attention because people don't have confidence to try. If you're are one of them just ensure that;

  1. README.md is able to fetch the attension of visitors and have all the necessary links for documentation, tutorials, demo projects, linked libraries, contributors etc.
  2. You've good documentation or guidelines to use your project.
  3. You have at least 90% test coverage and it is mentioned on README.md
  4. Project license don't stop users to try it.

Other than the checklist given above, people still need to know about your project and why they should try that. For that, please raise an issue with

  1. Necessary detail of your project in summary (rest detail can be read from the README.md of your project)
  2. Comparision with existing libraries to know people why should they switch.
  3. Aim/purpose of your project
  4. Why someone use this project.

We'll review your request and your opensource project. We'll suggest if any change is needed. We'll star deserving projects.