From 5cc1043c39806d7d199bc2d52df1a201ffc22ee2 Mon Sep 17 00:00:00 2001 From: Raj <42045620+rajp152k@users.noreply.github.com> Date: Thu, 19 Dec 2024 14:10:25 +0530 Subject: [PATCH] docs: grammar fix (#676) ## What type of PR is this? /kind documentation ## What this PR does / why we need it: TODO ## Which issue(s) this PR fixes: Signed-off-by: Raj Patil --- pkg/README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/pkg/README.md b/pkg/README.md index 3c39e09c..b7b23491 100644 --- a/pkg/README.md +++ b/pkg/README.md @@ -4,7 +4,7 @@ Library code that's ok to use by external applications (e.g., `/pkg/mypubliclib` It's also a way to group Go code in one place when your root directory contains lots of non-Go components and directories making it easier to run various Go tools (as mentioned in these talks: [`Best Practices for Industrial Programming`](https://www.youtube.com/watch?v=PTE4VJIdHPg) from GopherCon EU 2018, [GopherCon 2018: Kat Zien - How Do You Structure Your Go Apps](https://www.youtube.com/watch?v=oL6JBUk6tj0) and [GoLab 2018 - Massimiliano Pippi - Project layout patterns in Go](https://www.youtube.com/watch?v=3gQa1LWwuzk)). -Note that this is not a universally accepted pattern and for every popular repo that uses it you can find 10 that don't. It's up to you to decide if you want to use this pattern or not. Regardless of whether or not it's a good pattern more people will know what you mean than not. It might a bit confusing for some of the new Go devs, but it's a pretty simple confusion to resolve and that's one of the goals for this project layout repo. +Note that this is not a universally accepted pattern and for every popular repo that uses it you can find 10 that don't. It's up to you to decide if you want to use this pattern or not. Regardless of whether or not it's a good pattern more people will know what you mean than not. It might be a bit confusing for some of the new Go devs, but it's a pretty simple confusion to resolve and that's one of the goals for this project layout repo. Ok not to use it if your app project is really small and where an extra level of nesting doesn't add much value (unless you really want to). Think about it when it's getting big enough and your root directory gets pretty busy (especially if you have a lot of non-Go app components).