Collecting hopefully useful info for newly-joined contributors to start. #246
Conversation
README.beginner-developer
Outdated
| @@ -0,0 +1,72 @@ | |||
| This is some collection to help recently joined coders to start with. | |||
| You can try the hard way. Then you just do not need to read any further. | |||
| Beleive me, at least for me, adds unnecessary frustration. | |||
There was a problem hiding this comment.
Well, among four of us, please let me explain my frustration. Not professional behaviour, I admit, and must excuse me for it...
Today I have somehow found out my root problem to this. In mid-school, I had a subject (~course), technical drawing, screws and other mechanical things, wiring diagrams, etc. We regularly used to have homework. For some, it was always accepted. For others, usually including me, it was rejected with the worst note, and when asking, why, the response always sounding "the newest standards....". Never seen anybody ever having seen such standards, by the way ;-) . And each and every week other standards ;-) ... Well, it did not disturb us very much that time, saying "she is an idiot". Nor did I face any similar situation since then, almost 50 years now. However, with tlf, both my two contributions resulted in this... Well, I know I do not get bad notes any more. Well, I know, everybody helps me, and everybody is happy to see any useful contributions. Still the fact is, I did my best, Zoli has checked it, I only wanted to lean back and be proud and happy, and then still again I was asked to correct things that I could in no way know in advance.
Such a list like this could have helped me. Kindly ask you, to your best, do please support this for me and for all future mates.
There was a problem hiding this comment.
This is part of collaborative development. I submitted some pull requests last month and there were some obvious things I missed that the others saw and their solutions were clearly better. For me it is an opportunity to learn and get better especially since I am self-taught in programming with no formal education in the field whatsoever. My studies were in electronics 30 years ago. I still melt solder on occasion but I greatly enjoy working with a few software projects.
There was a problem hiding this comment.
Well, I also am ready to learn. However, unhappy when I suddenly get the feeling I should have known something nowhere documented... And that was my feeling at the end, no matter how nice the missing point communicated to me by nice fellows...
|
I will note that 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 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
|
@ervin: @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:
|
README.beginner-developer.md
Outdated
|
|
||
| Recent code often uses different conventions. | ||
|
|
||
| Code is considered old when before ... |
There was a problem hiding this comment.
would be very thankful if somebody would please insert a year number here...
There was a problem hiding this comment.
Re travis: it is used for continuous integration, the expression in the MD file shows the latest build status.
Their statement is that open source projects can stay, so no immediate action is needed in my opinion. Until now all worked as before.
There was a problem hiding this comment.
Just FYI: Github has an own CI, we can leave Travis.
| @@ -0,0 +1,76 @@ | |||
| # Tlf ham radio contest logger | |||
There was a problem hiding this comment.
At this line in README.md, there is a link to http://travis-ci.org , no idea what for, Anyway, now I get
Please be aware travis-ci.org will be shutting down in several weeks, with all accounts migrating to travis-ci.com.
Could somebody please resolve this case please...
There was a problem hiding this comment.
see #246 (comment), commented the wrong thread
|
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 ha5se#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. |
Minor corrections and clarifications
|
How about closing this issue after 2+ years of inactivity? |
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.