{"id":212,"date":"2014-05-22T08:12:52","date_gmt":"2014-05-22T08:12:52","guid":{"rendered":"http:\/\/finaldie.com\/blog\/?p=212"},"modified":"2014-05-28T11:36:49","modified_gmt":"2014-05-28T11:36:49","slug":"the-steps-of-creating-a-new-open-source-library","status":"publish","type":"post","link":"https:\/\/finaldie.com\/blog\/the-steps-of-creating-a-new-open-source-library\/","title":{"rendered":"The Steps of Creating a New Open Source Library"},"content":{"rendered":"

Recently, I’m doing the refactoring job of fhash lib<\/a>, which is a part of flibs<\/a>, during the refactoring, I realised that to create a new open source project, we should have some basic steps, and follow the steps we will keep moving to right forward without lost.<\/p>\n

Steps<\/h3>\n

Ok, let’s check the core steps:<\/p>\n

    \n
  1. API Design Lock Down<\/li>\n
  2. Write the code<\/li>\n
  3. Write the UT<\/li>\n
  4. Write the benchmarking tools<\/li>\n
  5. Create a document of these APIs<\/li>\n
  6. Announce your library<\/li>\n<\/ol>\n

    The benefit of Writing Documents<\/h3>\n

    Most of developers don’t like to write the document, it’s so boring. But actually the document is not written only for yourself, it will be a great help for all the people who will maintain this project. Try to think a about it, if there is a open source library without any API document or comments in the code, will you use it in your project? The answer is NO<\/strong> obviously, so let me brief the benefits of writing document:<\/p>\n