[READ ME] Android Development section

---

(shamelessly copied and then modified from junkdruggler's post here)

This is a DEVELOPMENT section, not GENERAL. Do NOT post questions here!

Before continuing, read this post: http://forum.xda-developers.com/showthread.php?t=729511. It also contains a link to XDA's rules, read those as well !

Let's try to post our ROMs and threads the following way to make the forum quicker and easier to access:

[KITCHEN][WWE][08.08.08] KOKOTAS ELF(in) Hybrid Kitchen (version 1.3)
[PRJ][WWE][BETA] BRAM / NOONSKI Touch Surface 6.1 Public Beta Release Candidate Unskinned
[REF] NOONSKI Cooking Class Class of 2008/09
[UPG] HTCTOUCHP New USPLs & IPLs for Elf & Elfin
[ROM][EUR][UPD][11-07-10] Doc's BareboneGalaxy v6 [2.1-u1~XWJG3][LauncherPro BETA] Optmized APKs [Barebone]
[ROM][ARA][UPD][11-07-10] ??? v1.1 [2.1-u1~XWJG3][TouchWiz 3.0] ??? [FullArabic]
[ROM][EUR][UPD][06-07-10] MoDaCo r2 [2.1-u1~XWJG1][TouchWiz] JG1/SwypeFix [OnlineKitchen]

For ROM releases, use:

[ROM][%region%][%variant%][dd-mm-yy] %name% %version% [%Androidbuild%~%baseROM%][%launcher%] %mchangelog% [%specialfeature%]

Variables as follows:
%region% - If this is an update.zip the region of base firmware. If you focus your ROM on a specific language/country put it here. Use abbreviations: EUR (Euro), ARA (Arabic), USA (United States)
%variant% - Not very useful right now since we can only use update.zip. Will become important once we get complete android builds. Use abbreviations: UPD (Update), FW (Firmware)
%name% - Name of your ROM. Whatever you want to call it.
%version% - The version of your ROM.
%Androidbuild% - This is the basebuild of android that the firmware uses. 2.1-update1 for the firmwares we have available right now. (Make it short: 2.1-u1)
%baseROM% - This is the last five symbols of the firmware you base your ROM on/that is required to install your update.zip. for example: XWJG3
%launcher% - This is the launcher you use (preferably with the version used).
%mchangelog% - Give one or two of the most important changes in this update.
%specialfeature% - One special feature of your ROM. Barebone or Online kitchen or something like that qualifies

Just some examples based on the available ROMs

[ROM][EUR][UPD][11-07-10] Doc's BareboneGalaxy v6 [2.1-u1~XWJG3][LauncherPro BETA] Optmized APKs [Barebone]
[ROM][ARA][UPD][11-07-10] ??? v1.1 [2.1-u1~XWJG3][TouchWiz 3.0] ??? [FullArabic]
[ROM][EUR][UPD][06-07-10] MoDaCo r2 [2.1-u1~XWJG1][TouchWiz] JG1/SwypeFix [OnlineKitchen]

For upgrade tools (HSPL, SSPL, CID, SIM, etc.), use:

[UPG] Description

For complete kitchens, use:

[KITCHEN][Language] name and version (Build)

For projects, use:

[PRJ] description

For utilities, use:

[UTIL] name and version

For reference threads (tutorials, guides, etc.), use:

[REF] description

A good start to a good structure

I have tried creating a standard for the ROM naming before but for lack of a sticky, there is so far only one "chef" who uses it.

http://forum.xda-developers.com/showthread.php?t=723745

Interesting. I've just copy/pasted a different post who'se layout reminds me of other sections I've moderator, and which will look familiar to users coming from the WM forums to here. I am of course open to suggestions!

Let's discuss, critisize, and formalize. Your way of naming looks smart to me, so let me share my comments.

Your original:

[%variant% ~ %region%] [dd/mm/yy] %Name% {%version%} [%Androidbuild% ~ %baseROM%] {%launcher%} %mchangelog% [%specialfeature%]

Variables as follows:
%variant% - Not very useful right now since we can only use update.zip. Will become important once we get complete android builds (Update or Firmware)
%region% - If this is an update.zip the region of base firmware. If you focus your ROM on a specific language/country put it here.
%Name% - Name of your ROM. Whatever you want to call it.
%version% - The version of your ROM.
%Androidbuild% - This is the basebuild of android that the firmware uses. 2.1-update1 for the firmwares we have available right now. (Make it short: 2.1-u1)
%baseROM% - This is the last five symbols of the firmware you base your ROM on/that is required to install your update.zip. for example: XWJG3
%launcher% - This is the launcher you use (preferably with the version used).
%mchangelog% - Give one or two of the most important changes in this update.
%specialfeature% - One special feature of your ROM. Barebone or Online kitchen or something like that qualifies

Just some examples based on the available ROMs

[Update ~ Europe] [11/07/10] Doc's BareboneGalaxy {v.6} [2.1-u1 ~ XWJG3] {LauncherPro BETA} Optimized APKs [Barebone]

[Update ~ Arabic] [11/07/10] ??? {v1.1} [2.1-u1 ~ XWJG3] {TouchWiz3.0} ??? [FullArabic]
(Sorry for the questionmarks. I don't speak/read arabic. I wish I could :/)

[Update ~ Europe] [06/07/10] MoDaCo {r2} [2.1-u1 ~ XWJG1] {TouchWiz} JG1/SwypeFix [OnlineKitchen]

I would keep the [ROM] prefix, just to distinguish it from normal programs, utilities, upgrades, tutorials, etc.

I would also use abbreviations to keep things short, and cut down on whitespace. variant = [UPD/FW], region = [EUR/ARA/USA/....], AndroidBuild / baseROM, without the spacing. To prevent overkill of brackets, I would not bracket the version. Also as we are using dd/mm/yy notation, AFAIK it is more common to use - instead of /. And I really just hate curly brackets, but that's personal

Example:

[ROM][EUR][UPD][11-07-10] Doc's BareboneGalaxy v6 [2.1-u1~XWJG3][LauncherPro BETA] Optmized APKs [Barebone]

Comments ? Suggestions ?

Originally Posted by Chainfire

Interesting. I've just copy/pasted a different post who'se layout reminds me of other sections I've moderator, and which will look familiar to users coming from the WM forums to here. I am of course open to suggestions!

Let's discuss, critisize, and formalize. Your way of naming looks smart to me, so let me share my comments.

Your original:



I would keep the [ROM] prefix, just to distinguish it from normal programs, utilities, upgrades, tutorials, etc.

I would also use abbreviations to keep things short, and cut down on whitespace. variant = [UPD/FW], region = [EUR/ARA/USA/....], AndroidBuild / baseROM, without the spacing. To prevent overkill of brackets, I would not bracket the version. Also as we are using dd/mm/yy notation, AFAIK it is more common to use - instead of /. And I really just hate curly brackets, but that's personal

Example:

[ROM][EUR][UPD][11-07-10] Doc's BareboneGalaxy v6 [2.1-u1~XWJG3][LauncherPro BETA] Optmized APKs [Barebone]

Comments ? Suggestions ?

Those sound to me like sensible modifications. Now that I think back on it the curly brackets weren't really necessary ;) And the date... my version of Windows displays the date as dd/mm/yyyy so I'm really at a loss what is convention here. but it really doesn't matter. I like the dashes too :P

Alright, updated first post with the changed information.

Structure is badly needed! all people are polluting this forum with topics with only questions!

Nice kang

---

I think most of what I said came from a stericson post... not sure though... I like READ MEs... and stickies... and FAQs...

I see only 2 ways you are EVER gonna be able to enforce this:

1) you go modo crazy and start deleting/moving stuff massively
tho you might get tired of doing so after a week or 2 ^^

2) you find somone that can modify the vbulletin post/reply form, so that it integrates the exact syntax you'd like ppl to use to post, and deny posts if it's not correctly filled out.

GL

This does not require enforcing, nor is it an exact science.

Conventions like there are used all over XDA and are generally followed. As soon as a number of the top releasers start following it in a subforum, the rest will eventually follow. It will take a while, sure... but it will happen, once the beginners realise that a structured life is a better life.

You have the option to do things nice and structured, or you can make a mess of things, but hey it'll be the mess you have to wade around in

Well said, I like the XDA naming scheme, seems to work well. Is there a mod for this section yet? someone to sticky important posts for now would do