Skip to content

High Level Repo Review #1

@bensheldon

Description

@bensheldon

Hi Shera, @shawndrost asked me to do a high level review of your project and give some feedback that's (hopefully!) helpful. It looks like you're pretty active making commits, so maybe some of these things are already on your radar.

  • You have a good Readme, but it's also useful to fill out Github's native summary and URL link (up near the top of the top of the page by the repo header).
  • I noticed a lot of "todo" comments in your code. Instead of leaving comments, it's good practice to use a project/issue tracking system instead. Not only does it make these things more discoverable for possible 3rd party contributors. but it also can prevent you from overlooking something (either not implementing a feature, or not deleting a comment when you have implemented a feature and thus leading to confusion).
  • Your /client folder is a little messy. That's probably because you're still in progress, but you might want to better separate out the different js+css modules into separate folders
  • I saw you're using Stylus (badass!) but you're also committing generated CSS into the repo. This is usually bad practice (like committing JS that was generated from coffeescript), but I'm not sure if you can get meteor to automatically generate these files on deployment.

Otherwise the code itself is very well written and formatted. You're using good functional programming techniques and I can tell that you're trying to separate and modularize distinct functionality. Let me know if you have any questions or certain pieces you'd like my advice or help on.

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions