search

AnssiR66 / AlanStdLib

The Standard Library for ALAN Interactive Fiction Language
Other
6 stars 2 forks source link

Before Merging New Clothing System #65

Closed tajmone closed 5 years ago

tajmone commented 5 years ago

Ciao Anssi,

we should use this Issue as a thread to discuss questions before merging the new clothing system in master branch, because the dev-clothing branch introduces significant changes to the Library and we want to make sure that the transition is smooth.

Questions like updating documentation (e.g. in the code, but also in the Alan Cookbook) and example adventures, as well as discussing the next StdLib version number, etc., should be discussed here.

tajmone commented 5 years ago

Clothing Instructions in lib_classes.i

I'm polishing up the dev branch (sorry for the dealy but I'm buried in procrastinated work lately).

Regarding the commented instructions on using clothing, inside lib_classes.i:

the whole instructions need to be revised to mirror the new clothing system. Also, the Clothing Table would now only be an example of how common clothing could be implemented, for the new system no longer imposes exponential layer values nor hardcoded layers for special clothing like skirts and coats.

Since I'll also be updating the Clothing Guide document to mirror the new clothing system, and I intend to make it a full tutorial with small example adventures that show how to implement basic, intermediate and advanced clothing, I was wondering wether we should still keep the clothing instructions in lib_classes.i or just stick to the Clothing Guide document and its examples.

I think it's worth investing more energy in documentation/tutorials in the extras/ folder and avoid duplicate efforts of having to maintain also instructions in the library sources comments. Possibly, we could limit instructions in library sources to basic guidelines and very small examples, but avoid full blown instructions like the INSTRUCTIONS FOR USING THE CLOTHING CLASS section.

Although the extras/ folder currently contains just a document for using clothing, my intention is to make it grow to a full collection of tutorials with example adventures in the future — possibly becoming something like your Cookbook, but more like individual recepies or tutorial per topic.

What's your view on this?

AnssiR66 commented 5 years ago

HI Tristano! I agree with you that we can scrap the instructions from the library code, it just takes space and makes compiled game files bigger. Good that you are working on the tutorial; we can include that in the library manual once it's ready. As you have implemented the new code for the clothing class, I think it's wise if you coin up the manual for it first and then we can integrate it to the full library manual consequently. We'll be in touch! Anssi

From: Tristano Ajmone notifications@github.com Sent: Wednesday, March 27, 2019 12:17 PM To: AnssiR66/AlanStdLib Cc: Subscribed Subject: Re: [AnssiR66/AlanStdLib] Before Merging New Clothing System (#65)

Clothing Instructions in lib_classes.i

I'm polishing up the dev branch (sorry for the dealy but I'm buried in procrastinated work lately).

Regarding the commented instructions on using clothing, inside lib_classes.i:

the whole instructions need to be revised to mirror the new clothing system. Also, the Clothing Table would now only be an example of how common clothing could be implemented, for the new system no longer imposes exponential layer values nor hardcoded layers for special clothing like skirts and coats.

Since I'll also be updating the Clothing Guidehttps://github.com/AnssiR66/AlanStdLib/blob/master/extras/Clothing_Guide.asciidoc document to mirror the new clothing system, and I intend to make it a full tutorial with small example adventures that show how to implement basic, intermediate and advanced clothing, I was wondering wether we should still keep the clothing instructions in lib_classes.i or just stick to the Clothing Guidehttps://github.com/AnssiR66/AlanStdLib/blob/master/extras/Clothing_Guide.asciidoc document and its examples.

I think it's worth investing more energy in documentation/tutorials in the extras/https://github.com/AnssiR66/AlanStdLib/tree/master/extras folder and avoid duplicate efforts of having to maintain also instructions in the library sources comments. Possibly, we could limit instructions in library sources to basic guidelines and very small examples, but avoid full blown instructions like the INSTRUCTIONS FOR USING THE CLOTHING CLASS section.

Although the extras/https://github.com/AnssiR66/AlanStdLib/tree/master/extras folder currently contains just a document for using clothing, my intention is to make it grow to a full collection of tutorials with example adventures in the future — possibly becoming something like your Cookbook, but more like individual recepies or tutorial per topic.

What's your view on this?

— You are receiving this because you are subscribed to this thread. Reply to this email directly, view it on GitHubhttps://github.com/AnssiR66/AlanStdLib/issues/65#issuecomment-477079599, or mute the threadhttps://github.com/notifications/unsubscribe-auth/AF2lHuzlc9KVoBUATav23xyB9OrnLhHIks5va0UggaJpZM4cNagz.

tajmone commented 5 years ago

Bumping to StdLib v2.2

Anssi,

because the new clothing system introduces backward compatibility breaking changes, I strongly suggest that when the new system is merged in the library bumps to v2.2.

This could be the right moment to start enforcing a strict version scheme in the repository, with v2.2 being the first tagged release.

I can't stress enough the importance of adhering to a versionin scheme. Beside avoid that slightly different version of the library start to circulate under the same version number, the main benefits of a strict version scheme become apparent when using the GitHub API and third party services:

So, my initial proposal in this respect is:

This being the first tagged release, it might be worthy taking care of any improvements that are worth — we can discuss them in this thread. I'm of the opinion that it's worth posticipating the release for the sake of a well grounded first tagged release, after all we are not in a hurry (and all the code is available in branches, if someone really can't wait).

After the first tagged release, all future development should take place in branches, are only be merged in master when a new release is ready (or a hotfix patch is reuired).

P.S. — I apologize for the long delay in the branch polishing work, but I had to deal with some problems relating to the end-of-life of Ruby Sass and having to switch to Dart Sass in many of my project, which also affected the Asiidoctor to HTML toolchain, and integration of Highlight for Alan, which in turn affected all Alan-related projects. (today I've finally managed to integrate those changes also here).

Now that I've solved all those problems, I can finally dedicate myself again to the StdLib/Alan Italian projects.

tajmone commented 5 years ago

The discussion on changes to be done before release 2.2 has now moved to a dedicated issue: #70.