Re: GSoC 2020 update: Aug 7
Hello Owen, > That said, once I begin finalizing, what would that entail? I'd > imagine something like the following: > >- First, I'd look at all the TODO's I've left myself and try to > resolve them as best I can. It depends. Some TODOs certainly need a very large amount of time and don't gain much. You have to judge whether it is worth the time *right now*, or whether to delay. >- Then, I'd rebase my commits onto the latest master and make the > history a little nicer. For instance, I'd combine some commits > that were incremental changes towards a particular goal, so > it'll be easier to judge each facet of my work at a glance. Maybe it makes sense to create a new branch from scratch instead of fiddling with existing commits. As mentioned in another e-mail, it is in general not necessary to provide a series of commits for a new file. Simply commit the new file as a whole instead. Incremental commits in logical units only make sense (in most cases) for already existing files that you have to modify. >- Then, I'd make changes to LilyPond's docs. This includes any > internal comments that may have become outdated. Yep. >- Then, I'd take all your feedback regarding my commits, to make > sure there aren't any last-minute typos. Please tell us when you have something we should look at. >- Then, I'd run tests to make sure everything works as intended > and can be added to LilyPond. I believe we have a suite of > regression tests for this, so I guess I'll learn how to run > that. You probably have to write some regression tests by yourself. The idea is to get as much code coverage as possible for your changes, and each test should test as little as possible to make debugging easier. >- Once everything checks out, as Jean suggested, I'll write a > blog post on lilypondblog.org, summarizing my work, what I > learned on the way, and where things need to head next for > SMuFL on LilyPond. Yes... >- ...and it looks like that post can double as my required GSoC > summary, as long as I get it in by the 23rd! ...and yes. Werner
Re: GSoC 2020 update: Aug 7
On Fri, Aug 7, 2020 at 10:06 PM Urs Liska wrote: > Hi Owen, > > it's always a pleasure seeing your project evolve and proceed. I'd like > to throw in a comment, although I'm rather sure it isn't actually > needed. > I don't recall reading anything about it but probably you have thought > about it right from the start, so please take this as just a friendly > reminder. > On the contrary! I'm pretty forgetful, and this reminder is just what I needed to get my ducks in a row. Now that the deadline of the project starts coming into view you should > keep in mind that the priority is to have your work properly tested, > cleaned-up and merged. This is much more important than getting one or > more further features implemented - even if they should be your pet > features or seem crucial. > As far as I can see your work so far has been extremely useful, and it > will remain so even if at the end of GSoC it's not in a state that > every user can use it out-of-the-box. > OTOH if I understood the recent discussion about merging and rebasing > correctly your code itself has not been reviewed at all so far? In that > case you should definitely expect the review process to take longer > than you initially expect... Even without serious issues the review > process for getting anything into LilyPond is somewhat time-consuming. > > So I encourage you to plan from the end backwards and don't push the > possibly tedious and boring tasks of finalizing your work too much away > . > That's a good point. Considering, too, that school is starting for me soon, I probably should start finalizing things soon--a couple days from now, even. That said, once I begin finalizing, what would that entail? I'd imagine something like the following: - First, I'd look at all the TODO's I've left myself and try to resolve them as best I can. - Then, I'd rebase my commits onto the latest master and make the history a little nicer. For instance, I'd combine some commits that were incremental changes towards a particular goal, so it'll be easier to judge each facet of my work at a glance. - Then, I'd make changes to LilyPond's docs. This includes any internal comments that may have become outdated. - Then, I'd take all your feedback regarding my commits, to make sure there aren't any last-minute typos. - Then, I'd run tests to make sure everything works as intended and can be added to LilyPond. I believe we have a suite of regression tests for this, so I guess I'll learn how to run that. - Once everything checks out, as Jean suggested, I'll write a blog post on lilypondblog.org, summarizing my work, what I learned on the way, and where things need to head next for SMuFL on LilyPond. - ...and it looks like that post can double as my required GSoC summary, as long as I get it in by the 23rd! That's the best process I can think of, but let me know if I'm missing anything. Thanks, Owen
Re: GSoC 2020 update: Aug 7
Now that the deadline of the project starts coming into view you should keep in mind that the priority is to have your work properly tested, cleaned-up and merged. This is much more important than getting one or more further features implemented - even if they should be your pet features or seem crucial. As far as I can see your work so far has been extremely useful, and it will remain so even if at the end of GSoC it's not in a state that every user can use it out-of-the-box. OTOH if I understood the recent discussion about merging and rebasing correctly your code itself has not been reviewed at all so far? In that case you should definitely expect the review process to take longer than you initially expect... Even without serious issues the review process for getting anything into LilyPond is somewhat time-consuming. So I encourage you to plan from the end backwards and don't push the possibly tedious and boring tasks of finalizing your work too much away. ———- Owen, Additionally (and sorry if this is obvious), I think would be great if you could keep half a day for writing a blog post on [1]http://lilypondblog.org/. This will help communication about your project in the community. Best, Jean References 1. http://lilypondblog.org/
Re: GSoC 2020 update: Aug 7
Hi Owen, it's always a pleasure seeing your project evolve and proceed. I'd like to throw in a comment, although I'm rather sure it isn't actually needed. Am Freitag, den 07.08.2020, 21:49 -0700 schrieb Owen Lamb: > Hi all! > > ... > > --turned out to be a major point of difference between > LilyPond's and SMuFL's treatment of flags. > > I've slightly modified my general project approach, > > ... > > The school year is almost upon us here in AZ, and, as I mentioned at > the > beginning of summer, there'll be some overlap with GSoC. I'll be out > for > the count for a couple weekdays next week, so I'll pick up Saturday > to make > up for it. After that, I expect to be doing more night/weekend hours > as > classes start up the following week on the 20th. > > My plan is largely the same as it was last week. If you have any > questions/concerns, as always, feel free to ask away! I don't recall reading anything about it but probably you have thought about it right from the start, so please take this as just a friendly reminder. Now that the deadline of the project starts coming into view you should keep in mind that the priority is to have your work properly tested, cleaned-up and merged. This is much more important than getting one or more further features implemented - even if they should be your pet features or seem crucial. As far as I can see your work so far has been extremely useful, and it will remain so even if at the end of GSoC it's not in a state that every user can use it out-of-the-box. OTOH if I understood the recent discussion about merging and rebasing correctly your code itself has not been reviewed at all so far? In that case you should definitely expect the review process to take longer than you initially expect... Even without serious issues the review process for getting anything into LilyPond is somewhat time-consuming. So I encourage you to plan from the end backwards and don't push the possibly tedious and boring tasks of finalizing your work too much away . Best Urs > > Thanks, > Owen
GSoC 2020 update: Aug 7
Hi all! I've been pretty active on the mailing list this week, so you can see what I've been up to by checking out the archive. Essentially, what first seemed to be a minor inconvenience--a grob misplacement--turned out to be a major point of difference between LilyPond's and SMuFL's treatment of flags. I've slightly modified my general project approach, making room ahead of time for anything SMuFL can't take care of. That way, I don't have to sit around waiting for the standard to update to keep my work up. I have not yet added SMuFL's engravingDefaults to Emmentaler, but I've begun investigating where LilyPond gets its current metrics. Oddly, some metrics seem to be hardcoded, despite being present in the old LIL* tables as well. I'll continue that investigation next week. The school year is almost upon us here in AZ, and, as I mentioned at the beginning of summer, there'll be some overlap with GSoC. I'll be out for the count for a couple weekdays next week, so I'll pick up Saturday to make up for it. After that, I expect to be doing more night/weekend hours as classes start up the following week on the 20th. My plan is largely the same as it was last week. If you have any questions/concerns, as always, feel free to ask away! Thanks, Owen
