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

[PR] Initial implementation #3

Merged
merged 24 commits into from
Dec 27, 2022
Merged

[PR] Initial implementation #3

merged 24 commits into from
Dec 27, 2022

Conversation

LuchoTurtle
Copy link
Member

@LuchoTurtle LuchoTurtle commented Dec 19, 2022

closes #2

It's still in-progress.

This PR adds a working example of showing the mutations related to a specific item.
The user double-clicks an item and the referring mutations are shown to the right.

image

  • Add initial implementation
  • Readme
  • Add tests
  • Add CI

@LuchoTurtle LuchoTurtle added enhancement New feature or request good first issue Good for newcomers labels Dec 19, 2022
@LuchoTurtle LuchoTurtle self-assigned this Dec 19, 2022
@LuchoTurtle
Copy link
Member Author

I still need to write the README.

@nelsonic
Copy link
Member

Good work so far. But ...

not-writing-the-readme-major-red-flag

Please scrap this and re-create the project from scratch and write the README.md while you are creating the App.
Retrospectively writing the docs is "no bueno" because you will always skip steps.
If the building was burning down and I could only save one thing it would be the README.md, not the /lib folder.
So please make the README.md as good as it possibly can be at every step of your journey.
Be concise but complete with the steps you write.
Don't bother with renaming the project from App to SpikePapertrail that will never be a requirement; ever.
Naming things is suuuper important. Repos are descriptive. Project files are namespaced "App".
Apologies if this has been inconsistent in some of our projects, e.g:
dwyl/phoenix-chat-example/blob/main/lib/chat_web/controllers/page_controller.ex
I haven't had time to retrospectively go back and "fix" everything.
But on the newer tutorials and our MVP, this has been App for a while ...
e.g: /dwyl/phoenix-todo-list-tutorial/blob/main/lib/app_web/controllers/item_controller.ex#L1
But even "Chat" as an App name isn't that bad - not much more typing than App ...
But the whole point of having App as the App's name
is so that when something works in one of the "experiments",
we can easily transfer the feature to our "main" App. 💭

Nuked project. Added tests and tinkered with `routes` order to get back to 100% coverage.
@LuchoTurtle
Copy link
Member Author

Nuked and started from scratch. It's still ongoing but I just want to give a status update.
Since I'm using the project without auth and api (since they're not yet merged and also makes it easier for this SPIKE), had to clone it from this version https://github.com/dwyl/phoenix-todo-list-tutorial/tree/ab4470d68f64ed8f5596dd09f3322193317b838e and had to add some tests/tinker with routes to get coverage to 100%. The project still 100% works.

@LuchoTurtle
Copy link
Member Author

The initial implementation should be finalized.
Going to add CI to this PR.

@codecov
Copy link

codecov bot commented Dec 20, 2022

Codecov Report

❗ No coverage uploaded for pull request base (main@b4c0315). Click here to learn what that means.
The diff coverage is n/a.

❗ Current head 6f40836 differs from pull request most recent head 62db7ef. Consider uploading reports for the commit 62db7ef to get more accurate results

@@           Coverage Diff            @@
##             main        #3   +/-   ##
========================================
  Coverage        ?   100.00%           
========================================
  Files           ?         9           
  Lines           ?        64           
  Branches        ?         0           
========================================
  Hits            ?        64           
  Misses          ?         0           
  Partials        ?         0           

📣 We’re building smart automated test selection to slash your CI/CD build times. Learn more

@LuchoTurtle
Copy link
Member Author

Just added CI and fixed warnings.
I haven't uploaded to Fly.io because I wager it makes sense only deploying after you review this PR.

@nelsonic
Copy link
Member

@LuchoTurtle quite keen to get this shipped to Fly.io especially as all the code is already in place (Dockerfile, fly.toml etc.) Please assign to me when you feel it's ready for review. 🙏

@LuchoTurtle LuchoTurtle requested a review from nelsonic December 24, 2022 11:51
@LuchoTurtle LuchoTurtle assigned nelsonic and unassigned LuchoTurtle Dec 24, 2022
@LuchoTurtle
Copy link
Member Author

All yours 👍

Copy link
Member

@nelsonic nelsonic left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@LuchoTurtle initial implementation looks good, thanks! 👍

@nelsonic nelsonic merged commit 4d6abd3 into main Dec 27, 2022
@nelsonic nelsonic deleted the v1 branch December 27, 2022 23:59
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
awaiting-review enhancement New feature or request good first issue Good for newcomers
Projects
Status: Done
Development

Successfully merging this pull request may close these issues.

Create Working Example
2 participants