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

Remove all references to metadata from README.md to avoid confusion. #22

Merged
merged 2 commits into from Jan 25, 2020

Conversation

nelsonic
Copy link
Member

It appears that the metadata section in the README.md #what-about-metadata was confusing ... #19
We don't need to introduce people to the concept of metadata at all.
So I have completely removed it and replaced it with a section about displaying the count in the UI.

@codecov
Copy link

codecov bot commented Jan 25, 2020

Codecov Report

Merging #22 into master will not change coverage.
The diff coverage is n/a.

Impacted file tree graph

@@          Coverage Diff          @@
##           master    #22   +/-   ##
=====================================
  Coverage     100%   100%           
=====================================
  Files           2      2           
  Lines         244    244           
  Branches       76     76           
=====================================
  Hits          244    244

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 0753320...2684589. Read the comment docs.

Copy link
Contributor

@miguelmartins17 miguelmartins17 left a comment

Choose a reason for hiding this comment

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

Perhaps if Metadata does not enter this application as a necessary tool it would be better to remove it so as not to cause any doubt.
Unless I was the only one asking.

@nelsonic
Copy link
Member Author

@miguelmartins17 it's always helpful to have a completely fresh perspective on things.
Yes, there have been hundreds of people who have read/followed this tutorial and not been confused by the section on metadata. But that doesn't matter. What matters is the one person who does get confused by it and it halts their progress. The last thing I want is for anyone to "halt and catch fire" ...
So I thank you for highlighting that the tutorial needlessly introduces a complex topic!
I re-read the section with fresh eyes and determined that it can be re-written to remove the concept of metadata completely.

@miguelmartins17 miguelmartins17 merged commit e89bffa into master Jan 25, 2020
@nelsonic nelsonic deleted the remove-refernce-to-metadata-issue#19 branch January 25, 2020 10:07
@miguelmartins17
Copy link
Contributor

Wrong button was trying to approve this request. 😨
I'll keep learning more about Git, I still have a lot to improve.

@nelsonic
Copy link
Member Author

@miguelmartins17 generally when a Pull Request is assigned to a specific person, it is that person's responsibility to review and merge. 🙄
I requested a review from you, but the PR was assigned to @iteles for her to read and confirm that what I have changed makes sense before being merged. 💭
Please bare that mind in future.
Sorry if it wasn't clear in https://github.com/dwyl/contributing
We will need to make it clear in future to avoid by confusion. 👍

@miguelmartins17
Copy link
Contributor

It makes sense, my goal was really just to approve this review not to merge.
It was my mistake, not yours, and I didn't mean to, but I thought that the button would just say that I approve, not that I would merge the requests.

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
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants