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.

Sign up for GitHub

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

Jump to bottom

Code reuse publishing to hexpm issue #95 #146

Merged
merged 32 commits into from
Jun 22, 2022
Merged

Code reuse publishing to hexpm issue #95 #146

merged 32 commits into from
Jun 22, 2022

Conversation

nelsonic
Copy link
Member

@nelsonic nelsonic commented Oct 31, 2019 •
edited
Loading

The purpose of this PR is to show a real world example for re-using code ... #95 ♻️
It's not "finished" but it already contains a lot of useful info so I think it's worth merging. 💭
We can extend it when life is a bit less hectic. 🤞

@nelsonic
add outline of code reuse example for #95
a9a674b
@nelsonic
add intro to reusable code for #95
7c3056d
@nelsonic
add outline of why/what we are building #95
8b65a11
@nelsonic
you're doing it wrong ...
5f0f3cc
@nelsonic
add use case example with screenshots for #95
9350ea5
@nelsonic
rename file for brevity #95
2bcff39
@nelsonic
attempt anchor hyperlink inside superscript
7886c33
@nelsonic
add code after running mix new quotes for #95
1827a43
@nelsonic
tree -a (directory listing for quotes package)
3ab1047
@nelsonic
begin explaining initial files in quotes project #95
bc2bb31
@nelsonic
add list of sources of quotes for #95
dd1512f
@nelsonic
add sample quotes
b709993
@nelsonic
add link to list of quotes.json
8874a4b
@nelsonic
tidy up intro to code reuse #95
081f30e
@nelsonic
add section on selecting JSON parsing dependency (Jason) for #95
18e7467
@nelsonic
add section on running the tests *before* writing any code #95
2d29d7a
@nelsonic
might need to move the section on documentation to somewhere else ... 💭
42551f7
@nelsonic
add @doc comment block for Quotes.parse_json function #95
2f24fca
@nelsonic
"Documentation is a love letter that you write to your future self" ~…
4954530 
… Damian Conway
@nelsonic
add instructions for how to test Quotes.parse_json function #95
4ddc818
@nelsonic
add @doc comment for Quotes.random() for #95
ca68e46
@nelsonic
finish writing up instructions for Quotes.random #95
aa8f49f
@nelsonic
add instructions to auto-generate the docs using ex_docs see: #95 (co…
e296aae 
…mment)
@nelsonic
add sample "random" quote for code reuse example #95;
96298a3
@nelsonic
add instructions and expected output for publishing package on hex.pm #…
c05fa90 
…95
@nelsonic
update all links from nelsonic/quotes to dwyl/quotes (repo transferre…
8b491a1 
…d to @dwyl) #95
@nelsonic
add instructions (and screenshots) for publishing to hex.pm #95
aae051c
@nelsonic
add code block around birthday paradox cal to avoid Markdown gobbling…
529f982 
… it up as regular text #95
@nelsonic
comment out bulk of note on "self-documenting code"
6815d5a
@nelsonic
cut down "What?" section of code reuse #95
fa71157
@nelsonic nelsonic moved this from More ToDo ThanCanEver Be Done to Awaiting Feedback/Review in Nelson's List Apr 7, 2022
@nelsonic nelsonic assigned SimonLab and unassigned iteles Apr 12, 2022
@nelsonic nelsonic requested a review from SimonLab April 12, 2022 06:49
This was referenced Apr 12, 2022
Closed
Closed
@nelsonic
Copy link
Member Author

@SimonLab this is totally not urgent. Defo focus on your work-work first. 👍
It will be useful to people learning Elixir so keen to publish at some point. :shipit:
Thanks.

@nelsonic nelsonic added enhancement New feature or enhancement of existing functionality T25m Time Estimate 25 Minutes labels Apr 12, 2022
@nelsonic nelsonic mentioned this pull request May 27, 2022
Closed
@nelsonic nelsonic added the priority-2 Second highest priority, should be worked on as soon as the Priority-1 issues are finished label Jun 10, 2022
@nelsonic
Copy link
Member Author

@SimonLab when you have T25m please read through this and provide feedback. 👍

@iteles iteles added this to To do in Simon's list Jun 10, 2022
@SimonLab SimonLab moved this from To do to In progress in Simon's list Jun 17, 2022
SimonLab
SimonLab reviewed Jun 17, 2022
View reviewed changes
Copy link
Member

@SimonLab SimonLab left a comment

Choose a reason for hiding this comment

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

A few typos to fix.
Content looks good. I think the section Reuse Code Without Publishing to Hex.pm is empty at the moment but we can complete it on a future PR

code-reuse-hexpm.md Outdated Show resolved Hide resolved
code-reuse-hexpm.md Outdated Show resolved Hide resolved
code-reuse-hexpm.md Outdated Show resolved Hide resolved
code-reuse-hexpm.md Outdated Show resolved Hide resolved
code-reuse-hexpm.md Outdated Show resolved Hide resolved
code-reuse-hexpm.md Outdated Show resolved Hide resolved
code-reuse-hexpm.md Outdated Show resolved Hide resolved
code-reuse-hexpm.md Outdated Show resolved Hide resolved
code-reuse-hexpm.md Outdated Show resolved Hide resolved
code-reuse-hexpm.md Outdated Show resolved Hide resolved
@SimonLab SimonLab added in-review Issue or pull request that is currently being reviewed by the assigned person and removed awaiting-review An issue or pull request that needs to be reviewed labels Jun 17, 2022
@SimonLab SimonLab moved this from In progress to Awaiting Feedback/Review in Simon's list Jun 17, 2022
@nelsonic @SimonLab
Apply suggestions (typo fixes) from code review
7f9e2ff 
Co-authored-by: Simon <simon.labondance@gmail.com>
@nelsonic nelsonic added awaiting-review An issue or pull request that needs to be reviewed and removed in-review Issue or pull request that is currently being reviewed by the assigned person labels Jun 22, 2022
@nelsonic nelsonic moved this from Awaiting Feedback/Review to To do in Simon's list Jun 22, 2022
SimonLab
SimonLab approved these changes Jun 22, 2022
View reviewed changes
Copy link
Member

@SimonLab SimonLab left a comment

Choose a reason for hiding this comment

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

Thanks for fixing the typos 👍

@SimonLab SimonLab merged commit f04ae16 into master Jun 22, 2022
Nelson's List automation moved this from Awaiting Feedback/Review to Done Jun 22, 2022
@SimonLab SimonLab deleted the code-reuse-publishing-to-hexpm-issue#95 branch June 22, 2022 14:15
@SimonLab SimonLab moved this from To do to Done in Simon's list Jun 22, 2022
@nelsonic
Copy link
Member Author

Thank you for reading it with a close eye and making all the typo-fixes, Simon! 🙌 🚀

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@SimonLab SimonLab SimonLab approved these changes

Assignees

@nelsonic nelsonic

@SimonLab SimonLab

Labels
awaiting-review An issue or pull request that needs to be reviewed enhancement New feature or enhancement of existing functionality priority-2 Second highest priority, should be worked on as soon as the Priority-1 issues are finished T25m Time Estimate 25 Minutes
Projects
Nelson's List
  
Done
Simon's list
Done
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

None yet
3 participants
@nelsonic @SimonLab @iteles