Benoit_Tgt
Get feedback on a small project
Hello
I made a small project using Elixir and Plug (https://github.com/benoittgt/PhubMe). I’m looking for feedbacks about my code (architecture, design, syntax, test…).
For example recently I received an interesting feedback mentioning this blog https://engineering.appcues.com/2016/02/02/too-many-dicts.html about using structs as method params.
When do you start putting methods in the module that define the struct?
Do you always write doc even if the project it doesn’t mean to be use as lib?
…
Thanks in advance
Most Liked
OvermindDL1
Not enough time at the moment for me to go through the code, but at the least:
Yes, or always try to at least, I even have credo set to enforce it as much as it can. Hard to have enough accurate docs. 
Qqwy
The idea of comments and documentation is to help someone who does not know exactly how everything in your codebase works to understand.
This includes you, three months in the future.
Popular in Discussions
Other popular topics
Latest on Elixir Forum
Sponsor Spotlight
Supporting innovation across the BEAM ecosystem.
Categories:
Sub Categories:
Forums
Popular Tags
- #ecto
- #liveview
- #troubleshooting
- #learning-elixir
- #deployment
- #library
- #erlang
- #testing
- #genserver
- #mix
- #absinthe
- #remote-other
- #otp
- #plug
- #how-to-question
- #macros
- #postgres
- #channels
- #elixirconf
- #exunit
- #discussion
- #javascript
- #code-sync
- #podcasts
- #onsite
- #dialyzer
- #docker
- #authentication
- #umbrella
- #full-time-contract
- #podcasts-by-brainlid
- #ecto-query
- #elixir-ls
- #phoenix_html
- #iex
- #blog-post
- #graphql
- #genstage
- #ai
- #websockets
- #supervisor
- #advent-of-code
- #elixirconf-us
- #distillery
- #processes
- #forms
- #api
- #metaprogramming
- #security
- #performance
Our Sponsors
Build Elixir applications with speed and confidence.
Supporting innovation across the BEAM ecosystem.
We build reliable cloud platforms for business-critical systems.
Catch errors, track performance, monitor hosts and more.
Real-time error tracking, performance insights, and observability for devs.
Practical resources that improve the lives of professional developers.
Producing high quality Elixir screencasts since 2017.
Enabling companies to succeed by building software people love.
Courses that'll move you from confusion to "Aha, now I get it!"