Tlf
Collecting hopefully useful info for newly-joined contributors to start.
Please leave this one for 7 more days open. I am in great hope to get much more points from active developers for the initial file.
I will note that git blame works so far as no major updates to a file took place, for example, styling changes or where tabs are replaced by spaces and nearly every line in a file gets updated. At that point about all one can do is check out a prior commit and look at git blame from there.
You do mention what I think is the hardest part of working with a project and that is that we all will write code a bit differently and will all approach a problem and apply logic slightly differently. My experience is that this is the most difficult aspect of joining a project. This can be eased somewhat by choosing descriptive names for variables and functions. Fortunately, Tlf does this a lot. Some projects use x, n, i, and other single character variable names everywhere which makes git grep practically useless. I will admit that I erred by allowing the variable name of the read character to remain as x when I updated the key handling code some years back. As I see it, single character variable names are fine in a for loop statement or where it is contained within a few lines. Once such names appear in more than one screen-full they become very difficult to track at a glance and especially years down the road!
I will caution that a file like this could become a best selling book!
My readme is just a preliminary work from a beginner, a very modest attempt, just to show what kind of info do I find missing. I still miss two more friends: C and git -- however, trying to becoming more of friends ;-) ... Every correction or any other suggestion is welcome.
Well, I was in fact adviced to delete my "done by" comment, upon reference to git knowing everything. All over my last almost 40 years career, I always used such comments, admitting without git. My best LMGTFY hit now was "git blame". If it or something better still does not cover the above requirement, then the active developers should probably discuss about still introducing (demanding) or at least allowing such "done by" comment blocks. For me, existing example is LZ3NY mods -- I personally like them, while only missing the date and short purpose from the one-liner...
I think this PR contains some usable information. If somebody uses Tlf it means he/she is a HAM radio amateur, not a programmer, and I think it can helps to understand the basics.
Btw IMHO that would be good to rewrite it as MD format, then I should put it to our Wiki - but we can put it into the source tree too.
Good point, thank you, will re-format. However, before next commit, first waiting a bit for new entries to arrive to the doc.
README.beginner-developer has now been renamed and re-formatted to README.beginner-developer.md ,
I have forgotten to delete the old file, sorry...
Please only merge .md .
@Ervin: README.md since "ever", now also README.beginner-developer.md are possible candidates for wiki that is empty right now...
@README.md: while it is unclear to me what the "https://travis-ci" line is for, still, anyway, please somebody maintain this, since as of today:
Please be aware travis-ci.org will be shutting down in several weeks, with all accounts migrating to travis-ci.com. Please stay tuned here for more information.
As I did not follow the discussion closely, may I ask what the actual state of the PR is? Is it ready to go in? What happens wrt the discussed transfer to the wiki?
Is any actions needed to go forward?
Well, the non-md file has been deleted, and as suggested I reformatted it to README.beginner-developer.md .
I was hoping to get some more points -- no additional points came. I am afraid I cannot add anything else to those points. I think if considered to be useful for others then could go in, otherwise should be dropped.
Under (1) still missing before what date or version or the like, should code blocks be suspect to be a bad example.
Did not touch README.md that still contains an outdating link to travis.ci . I used this as starting example, however from my .md I removed that link as suggested.
Some days ago I made a pull request to your code in your repo at https://github.com/ha5se/tlf/pull/1 . Did you have a chance to look over? I can apply it by myself but it would be good to get a feedback first.
