Editing/Reviewing

[luizperes]

This PR brushes up the files CONTRIBUTING and README. More edits will be done later :)

This closes #93

[codecov-io]

Codecov Report

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

@@          Coverage Diff           @@
##           master     #95   +/-   ##
======================================
  Coverage    83.7%   83.7%           
======================================
  Files           8       8           
  Lines         362     362           
======================================
  Hits          303     303           
  Misses         59      59

---

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 7768525...b95e5bb. Read the comment docs.

[ryukinix]

Thank you for this, @luizperes! This indeed helps.

[luizperes]

I have changed the points you mentioned. :) I believe it is much better now, please let me know what you think!

[luizperes]

That sounds good! Will change the it later tonight :)

[luizperes]

Have just done it. Please let me know what you think @ryukinix

[ryukinix]

Thanks for this.

[bradenbest]

Tell you what, to make up for all the pestering, I'll start working on my own proofreading pull request some time later today. Looking over the docs, I've already noticed some miscellaneous typos chiefly in the grammar and sentence flow departments. As a native English-speaker and friendly neighborhood grammar nazi, I'll put the docs through the same OCD edit re-edit proofreading rigor that I put my YouTube comments through, but without making it 18 paragraphs long!

[bradenbest]

@ryukinix Quick fact check: this is actually a fork of pushrax/mal and not from scratch, correct? It doesn't say so on the project page (where it usually says "forked from xxxx"), so I want to be sure.

Original: This project was initially inspired in pushrax/mal.
Planned edit: This project is a fork of pushrax/mal, which seems to have fallen out of maintenance.

[ryukinix]

@bradenbest In some way, yes, we can look this as a some type of fork, but not a GitHub fork however.

I indeed based most of the initial features on pushrax/mal, as the API and inc/dec stuff, but we have uncorrelated git histories, which can be confusing saying that is a fork on README.md. I based this works on pushrax/mal mainly because I was needing a mal CLI software and all what I found was pushrax/mal (and because that I'm referring about him on README.md until today).

I think we have more important stuff to take care and the way this fact is presented on README it's good enough describing what happened.

[bradenbest]

Got it, I'll say it's an "unofficial fork" to prevent people from thinking it's a direct GitHub fork.

[bradenbest]

Also, the README is lookin' pretty good. When I finish it, I'll submit a pull request and start working on the other docs