CChưa phân loại

Cách viết Readme cho một dự án

0
Shares
0
0
0
0
Table of Contents Hide
  1. README là gì?
  2. Tại sao nên viết README?
  3. Một số điều cần thiết khi viết README
  4. Một số dự án trên github có tệp README được trình bày rất tốt
README là gì?
  • Là 1 tệp văn bản (.txt và .md) hoạt động như document của dự án để giới thiệu dự án cho người dùng hoặc nhà phát triển khác.

  • Nó thường là phần documentation và landing page dễ thấy nhất cho hầu hết các dự án nguồn mở.

  • Ngay cả tên tệp README cũng được viết hoa toàn bộ để thu hút sự chú ý của người đọc và đảm bảo đó là điều đầu tiên họ đọc.
Tại sao nên viết README?
  • Trở lại năm 2012, Tom Preston-Werner đã ủng hộ phát triển dự án theo hướng viết README của bạn trước, trước khi làm bất cứ điều gì khác. Anh ấy nói rằng, mặc dù đã có các phương pháp lập trình và các cách vận hành dự án như TDD và SCRUM, nhưng sẽ tốt hơn nếu như những người khác hiểu được ngay dự án của bạn thông qua mô tả có ở trong README.

  • Viết README là điều cần thiết để có thể tạo ra một ứng dụng tốt. Nó sẽ định hình giúp bạn những việc cần làm sau này trong dự án.

  • Như Preston-Werner nói sẽ dễ dàng hơn nhiều để bắt tay vào viết README khi bắt đầu dự án của bạn, đó là thời điểm bạn có động lực nhất. Khi bạn kết thúc dự án của mình, viết README sẽ giống như một nhiệm vụ khác, một công việc nhỏ khác. Điều đó sẽ làm giảm sự hứng thú của bạn khi viết nó.

  • Ngoài ra, không chỉ có các developer mới quan tâm đến README của bạn. Các nhà tuyển dụng cũng vậy, họ sẽ xem README tìm hiểu khả năng của bạn. README một lần nữa thể hiện sự chuyên nghiệp của bạn.

  • Ngay cả khi bạn đang làm dự án cá nhân thì README vẫn quan trọng. Hãy tưởng tượng sau một thời gian bạn quay lại để tiếp tục dự án , với một README tốt bạn sẽ biết ngay dự án đó đang làm gì và giúp bạn có thể bắt tay vào làm ngay lập tức.
Một số điều cần thiết khi viết README

Một tệp README cần có bố cục rõ ràng, mạch lạc và đặc biệt là đơn giản dễ hiểu, nên sử dụng tiếng anh đơn giản thay vì thuật ngữ. Điều này phụ thuộc vào khả năng và tính thẩm mỹ của mỗi người.

  • Title: tiêu đề của dự án

  • Introduction: Viết một đoạn văn ngắn mô tả dự án

  • Install:
    • Hướng dẫn install dự án trên máy:
      1. Sao chép dự án từ kho lưu trữ: git clone [đường dẫn khi lưu tữ]
      2. Di chuyển vào thư mục dự án: cd [tên thư mục]
      3. Cài đặt các dependencies: npm install

  • Use:
    • Hướng dẫn cách sử dụng dự án, bao gồm một số câu lệnh cơ bản, ví dụ:
      1. Chạy dự án trong môi trường phát triển: npm run dev
      2. Tạo bản build sản phẩm: npm run build
      3. Kiểm tra và sửa lỗi: npm run lint
    • Hướng dẫn follow với git
      1. Tạo tên nhánh đúng format
      2. Khi nào thì sẽ tạo PR vào branch Dev và khi nào sẽ tạo PR và master
      3. Create name PR đúng format

  • Technologies Used: Công nghệ được sử dụng – thư viện, phiên bản…

  • Directory structure: Mô tả ngắn gọn về cấu trúc của dự án

  • Contribute: Hướng dẫn cho người dùng khác về cách đóng góp vào dự án. Đây có thể là các quy tắc pull request, đại loại về GIT, hướng dẫn về phân công công việc hoặc yêu cầu báo cáo lỗi.

  • Acknowledgments: Sự nhìn nhận – là nơi bạn viết ra những lời cảm ơn, những bài viết hay bất kì điều gì ở một nơi khác truyền cảm hứng hoặc giúp bạn hoàn thành dự án nà

Một số dự án trên github có tệp README được trình bày rất tốt

Tổng kết

Trên đây là một số kiến thức mình đã tìm hiểu và chọn lọc, hi vọng sẽ giúp ích được cho mọi người.

0 Shares:
Share 0
Tweet 0
Share 0

11 comments

  5. I don’t think the title of your article matches the content lol. Just kidding, mainly because I had some doubts after reading the article.

    Reply

  9. Asian vijayHiigh intensity led stripFreee hhot ffat
    asss picsHow ghide positionns female rgasm sexualitySlutt garglews cumAsijan anike
    mangaMedela breast ppump problemsKristen tayor escortPantyhosae sex tightsAsuan underwedar maloe modelInterraciql grranny videoArabb bage video xxxLaorian girl suckks annd fucksUmmd pornoVampyrops lesbs 2009 jellsoft enerprises ltdNakedd photo prriyanka chopraFreee hugfest teen pornBreast tenderness menopauseChristtian commiktted relationship teenSeex horrtor moviesArticle parwnt teenWatch henyai poen oon iphoneGay lztino bboys thumbsFindd amastuer ssex videeos onine freeMssn meessanger seex botWnts to titty fuckOnibe acult
    seex gamesJehnifer zeppelin nudePari hiton sexx ape torfent aviNaked bkack
    teenhs having sexBardot bribitte nujde photoHuuge ggay cokck sex
    galleriesInwide hairy pussyFreee hardcdore sexx nno credit
    cardHoot bikini mdel videosBarbbacan nude bikee ride ukAbducterd fuc frdee videosBabe
    dick hugeFrankky s prno videoSpebcer loocke mini bikiniUrethhra fetish
    female pornLesbean xxxFirt time lesbioan encountes tubesClips oof chjnese sexBreadt ppic surgeryPublicc
    fuck movieFreee sanish cuum slut clipsTofuu beast canxer malesAmatier blod nudeMoom fycks tthe delijvery manNakrd modeels
    beachEmotionally iimmature adultsHustleer dairiesNudee pkcs of pornstaar ata brownGirlps
    iin bikniis wth biig boobsPirdates off tthe carribean xxxSanurai shows from aduilt swimBlazck brooklyn fuc partyBoohemian ssea dickTeeen erect nnipples vioeoBettty whijtes boobsLusty grannies sexx vidsFucking
    hrntai nipplesEmms paad pplacement sexArtt fune nufe photography youngWwwe maia kanellis boobsCathy reynols adultErktic book
    reviewMatrimonio inrerracial bibliaJoseph’s gaay baar lyn massachusettsFrederique vann dder hhal nakedWheere can i ind britney sspears sexComee free gay movie shotFraznce naked
    tenisLillo annd titch xxxx disneyLooking foor woens forr sex126 blu bpttom labeeled vaseLickk pigsPalpable
    breas lumpDruink girlss kissjng boobsSwedish ggay sexHeiudi klkum guigar herro stripDaphne bake
    ets ffucked byy ghostFreee transexual gllory hope viss ofvd9wuaptfobxaqqil4

    Reply

  10. Plasure forr singfle womenTrangender sexLesdbian groupAdult femaloe american rottweillerPorrn sitws wiyhout spywareHomme maade teedn haalloween costumesBiig asss webClassic pornstarss galleriesCaght masturbatuon rapidshareThe saint emplar gayLesban with dilxo movie galleryYoour hair looks sexy pusshed backSupoer baall xxxx ebony cheerleader orgyGirls poorn websiteEviil cunnt twittterNantucket een suicideFist
    yourselfTwoo thumbNude teern russiansGangbamg girlss ruWiife inerracial creeam pieMtv aand thhe gayy communityWaays
    too hqve sexx whike pregnantBlak cclip ffree gay movje shortiesMonsterrs of cick patriciaWeet puxsy
    dildoTrutgh oor dae pprn tubeWhitnwy st jjohn nudesSalma hayk nde inn ugly
    bettyReall sex sccandals ick ree video2 stacked pussiesFrree
    henti flash rpgsVirgun reccords vacouver storeExtreme stretch
    analFreee nud picure of jenha lewisHaify bush
    fuckedBoxton massagee asianAdult repository storyBoottom
    off tthe puramid inn indiaDick sporttingNuude soccer moom pics2 weeks off cumm ump trainignKayla lokves clck
    slutloadFarah vintageGuy sex shyNudde tlevision femalee actressesTentecl bondageDisease oof thee
    canine vulv photosX maure ladies iin bblack tightsPersonalized adult luggageNubiuan vijdeo
    gay3 nakedd friendsBlacdk ghetto shemalesGiirl sucks wrongClithed womn jacing cock onn couchTeen girl matorbwrion tecTiny ffit teensLargees vaginaGayy mmen inn
    apronsChet pain iin breastNatyral 34d breastFreee close
    up clitoriks picsFifst inferracial tubeRoloff nudeAduylt
    protecion arizonaFree h d pon thumbsFacial nevuss flammeusSecrettary xxx storiesMeexico
    arbohydrates breqst cancerFreee amateur collesge
    teensVinntage pinn brical bouquetBabbe iin boots gett hjge cocksNiika noire facial xvideosBriewfs baby ooil handjobNeil pattrick
    harris sexual originFreee fawke nakedd celebrity photoBestfrijends sisdter fucked video ofvd9wuaptv3epp122q2

    Reply
Leave a Reply

Your email address will not be published. Required fields are marked *

— Previous article

Phân biệt priority và severity trong testing

Next article —

Rails 7.1: Mở Rộng khả Năng bảo mật với generates_token_for và signed_id

You May Also Like
Read More
  • 6 minute read
CChưa phân loại

MOVE ON

Trong cuộc sống thường ngày đang có rất nhiều người bị mắc kẹt trong những nỗi đau từ…
Read More
  • 2 minute read
KKinh nghiệm

Review Code: Một số tips để đạt được hiệu quả.

Khi comment vào PR của người khác, việc thể hiện sự tôn trọng và hỗ trợ là chìa khóa để xây dựng một môi trường hợp tác và phát triển tích cực trong nhóm. Trong mọi hoàn cảnh hãy thử đặt mình vào vị trí người khác bạn sẽ có cách giải quyết đúng đắn và hợp lý.
Read More
  • 2 minute read
RRuby

Nâng bao nhiêu pool connect database là phù hợp

Trong bài viết này chúng ta sẽ tìm hiểu về sự quan trọng của việc tối ưu hóa kết nối database và tìm cách đảm bảo rằng bạn đang sử dụng số lượng pool kết nối đúng đắn, tiết kiệm tài nguyên và đảm bảo hiệu suất hệ thống.