Developer notes

Customizer legacy documentation. This page may be useful for the contributors to get started, when looking into known issues or looking at historical reviews at below.

How to handle issues

When someone has submitted an issue, it is advisable to check the following criteria:

1. The issue still affects latest commit or release of Customizer at that time

2. The environment and factors that causing the issue are well known

3. Based on criterion 2., at least two users are able to reproduce the issue

Any given issue must satisfy criterion 1., else should be ignored. Provided with sufficient information, the user who had submitted the issue and one or more users should confirm the issue.

If the issue satisfies all three criteria above, apply the "official" label.

How to detail issues

For any given issue, the details may be written according to format below:

• Issue name (the title of issue, may be renamed later)
• Summary (short description of issue)
• Environment (operating system, applications affected)
• Description (long description of issue, including steps to reproduce the issue)
• Workaround (temporal cure or clever tricks with limitations, but doesn't solve the issue; effective only at a time because issue can reoccur)
• Solution (permanent cure that prevents or solves the issue)

These are originally part of standards used in the official user guide since 2012. Some old issues on GitHub were created "as it is" when moved from the official user guide i.e. issue #55 that was filed as ISSUE-2011-005.

Historical reviews

You should read this column to learn things done in the past and avoid errs in the future. The listing below is incomplete, given that this page was created impromptu.

• Choosing Python over Gambas, with advantages have been explained.

• Installation via make for 4.1 releases from the master branch based on Python2, using "injection" method has been noted and noted again.

• Working directory pathname with non-ASCII causing ISO image cannot be extracted. Because Python2 defaults to ASCII encoding. Commit f3bdc01 has resolved this, but may not be all.