Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Accommodate for a growing number of template functions #11

Closed
wants to merge 3 commits into from
Closed

Accommodate for a growing number of template functions #11

wants to merge 3 commits into from

Conversation

simenandre
Copy link
Contributor

Hello! 🎉

Thank you again for this awesome tool! Considering the growth this repository has had, I thought I could throw myself into trying to "organize it for growth" (feels very corporate thing to say). Anyway, what I did was move all Go files into internal, since, as of now there are no exported functions, and probably will not, right? Secondly, I added cmd/main.go.

I am but a novice Golang-programmer, so feedback would be magnificent. I'll improve as you see fit!

But, why not keep it as is?

Mostly because if files are kept being added, the repository tree will be very long and people hate scrolling to the README 😅.

Before After
.
├── Dockerfile
├── LICENSE
├── README.md
├── gists.go
├── go.mod
├── go.sum
├── humanize.go
├── main.go
├── repos.go
├── rss.go
├── sponsors.go
├── templates
│   └── github-profile.tpl
├── types.go
└── users.go
.
├── Dockerfile
├── LICENSE
├── README.md
├── cmd
│   └── main.go
├── go.mod
├── go.sum
├── internal
│   ├── gists.go
│   ├── humanize.go
│   ├── main.go
│   ├── repos.go
│   ├── rss.go
│   ├── sponsors.go
│   ├── types.go
│   └── users.go
└── templates
    └── github-profile.tpl

@muesli
Copy link
Owner

muesli commented Oct 31, 2020

@cobraz Apologies for not responding earlier, this one completely went under the radar and I just noticed there's an open PR left here 😟

I agree, there's definitely room to better organize the project. I think we should rather move the GitHub & GoodReads API (that now exists) into their own sub-packages in this repo. There's no need to hide them away. Something like humanize.go probably fits in either internal or a utils package (even though I typically despise them a bit).

If you're still interested in moving this forward, I'm happy to merge such a PR!

Sorry again!

@Techassi Techassi mentioned this pull request Apr 1, 2022
@simenandre simenandre closed this Apr 7, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants