commons-dev mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From Rahul Akolkar <rahul.akol...@gmail.com>
Subject Re: [SCXML] Development plan about SCXML Visual editor
Date Fri, 07 May 2010 15:23:28 GMT
2010/5/7 Xun Long Gui <ustbcoder@gmail.com>:
> Hi Rahul,
>
> I have finished EMF data model refactor job for this SCXML visual editor
> tool,you can find it in attach file.
>
<snip/>

Please submit any patches through the JIRA issue, rather than sending
them as attachments. The mailing list may drop attachments; but even
more importantly we want to have all patches come in through the
corresponding JIRA issues.

When you attach the initial zip to JIRA, please include a README.txt
file which contains detailed instructions on how to build and test the
code (including Eclipse Ganymede packages needed and where to get them
etc. as you mention in the Environment field of the JIRA issue).

Also, until we have the code in SVN and folks have had a chance to
look at it and provide comments, lets leave the corresponding JIRA
issue(s) open. I have accordingly reopened SCXML-127.


> This EMF data model is a important part of this project, i think you can
> share it in this project's sandbox SVN. And I will generate my start code
> with this EMF data model in the coming week, i need do some configuration
> jobs and generate source codes by Eclipse GMF framework, we can finish it
> soon. Once i finish this code generation job, i will send these codes to you
> to share it, i will may sure these codes are under SUN conventions, we can
> treat these codes as this project's start code.
>
<snap/>

OK. For generated code, it may be OK if it doesn't strictly match
coding conventions. Lets discuss once we have the generated code
before you spend any time editing the generated code.

Hand-written code, obviously, should follow the guidelines.


> At the same time, i have created a sub-tasks list for the original issue we
> have,
> SCXML-116 in Apache JIRA system.
<snip/>

Please also add two more sub-tasks as stretch goals, the steps 3 and 4
you mention here:

  http://markmail.org/message/uemrixakqseloxaa

Its understood that these may not be completed in GSoC time and are
aggressive goals, so we can mention that when the task is created in
JIRA, but I think its good to capture them in the list of tasks. We
can always re-evaluate as time progresses to include less or more as
the case may be.


> Once i finish a sub-task in my plan, i will
> submit my codes as a patch in to project SVN.
>
<snap/>

Yup, please attach those patches in time to the corresponding JIRA
issues as well. Thanks,

-Rahul


>
> 在 2010年5月6日 下午11:46,Rahul Akolkar <rahul.akolkar@gmail.com>写道:
>>
>> 2010/5/6 Xun Long Gui <ustbcoder@gmail.com>:
>> > Hi Rahul,
>> > Thank you for your response. Now i know what our work mode is. First, we
>> > split the whole project to a sub task list, finish it one by one, this
>> > first
>> > job in the list is submitting my start code in Commons sandbox SVN, then
>> > i
>> > should keep on submitting my code as patch to the project SVN.  But
>> > there
>> > are two points i should notice:
>> > 1. i can not check the source code directly, i should give you my codes
>> > and
>> > you check them for me.
>> > 2. my code should follow Sun conventions, i can refer to Commons SCXML's
>> > source code.
>> >
>> <snip/>
>>
>> Yes, both points above are correct.
>>
>>
>> > In the following days, i will finish my start code format job under Sun
>> > conventions and give it to you to share it to sandbox SVN. Then, i will
>> > make
>> > clear milestones of this project and finish them one by one, submit it
>> > as a
>> > patch to SVN once finish a sub task.
>> >
>> > But there are two small problems:
>> > 1. i can not open the mail you marked as 5 (
>> > http://markmail.org/message/hunh4xaoag3wiimu), so i am not sure what the
>> > sub
>> > task's format is. If i can find a example, i will know it better.
>> <snap/>
>>
>> I can access that URL. For example of sub-tasks, see:
>> https://issues.apache.org/jira/browse/ATTIC-1
>>
>> Also, let me paste the important portion of that message here:
>>
>> <paste src="http://markmail.org/message/hunh4xaoag3wiimu">
>>
>> On Tue, May 4, 2010 at 11:23 AM, Jacob Beard wrote:
>> > Hi,
>> >
>> > I'd like to start populating JIRA with tasks and milestones related to
>> > my GSoC project,
>> <snip/>
>>
>> +1
>>
>> > and I'm wondering what is the best way to go about
>> > this. I think these tasks should go under the SCXML project in
>> > JIRA[1], but I'm not sure if I should do more to differentiate them as
>> > a separate sub-project.
>> <snap/>
>>
>> One option is to create sub-tasks for the original issue you have,
>> SCXML-115 [1] (see LHS menu).
>>
>> This will create separate issues in JIRA for each task, so they can be
>> managed independently, but it will also neatly roll everything up
>> under the above umbrella issue. For an example of this (from another
>> project), see ATTIC-1 [2].
>>
>> What do you think about using this approach?
>>
>> -Rahul
>>
>> [1] https://issues.apache.org/jira/browse/SCXML-115
>> [2] https://issues.apache.org/jira/browse/ATTIC-1
>>
>> </paste>
>>
>>
>> > 2.i use my finished demo as start code, but i think there are many
>> > problems
>> > in the demo. The most important point is that this demo's data model is
>> > not
>> > complete, may be i should redo the data model and refactor source code,
>> > in
>> > fact, i am working on it. So, it is certainly that the first patch after
>> > start code is a very big patch.
>> >
>> <snip/>
>>
>> OK, I'd suggest not worrying about completeness to begin with.
>> Ideally, we want to get your initial code in SVN sooner rather than
>> later and then continue making smaller, incremental and regular
>> patches rather than large patches with more time in between (these
>> tend to be harder to follow, and harder to make changes to).
>>
>>
>> > Now i know mainly our work mode and i will finish start code format job
>> > as
>> > soon as possible to submit it, at the same time, i will keep on building
>> > data model structure for our project.
>> >
>> <snap/>
>>
>> Great, and again, its OK to have large parts left in TODOs in code and
>> thus getting started in the Commons Sandbox SVN sooner.
>>
>> -Rahul
>>
>>
>> > --
>> > Best Regards
>> >
>> > Gui Xun Long (桂训龙)
>> >
>> >
>> > 在 2010年5月6日 下午11:07,Rahul Akolkar <rahul.akolkar@gmail.com>写道:
>> >
>> >> 2010/5/5 Xun Long Gui <ustbcoder@gmail.com>:
>> >> > Hi Rahul,
>> >> >
>> >> > I am back and get ready for submitting my demo code to a SVN server,
>> >> > but
>> >> i
>> >> > do not know where can i share my code ? I saw something about GSoC
>> >> sandbox
>> >> > SVN server in the mail list but does not get the detail yet. So, i
am
>> >> > a
>> >> > little confused about how to start my sharing job, thank you.
>> >> >
>> >> <snip/>
>> >>
>> >> Yes, we are discussing what the SVN location should be for the GSoC
>> >> work in this [1] thread. We will create separate SVN spaces for both
>> >> the projects this year in the Commons sandbox [2, 3] order to:
>> >>
>> >>  * Make it easier for committers to provide and apply patches
>> >>  * Make it easier for GSoC participants to demonstrate mid-summer and
>> >> end of summer progress
>> >>
>> >> Likely, the creating of these directories in SVN will happen over the
>> >> weekend when I get a chance.
>> >>
>> >> For the purposes of populating the SVN space with your work (starter
>> >> code you have available now or soon), perhaps its best to follow the
>> >> approach below, if you agree:
>> >>
>> >>  * Create a list of tasks associated with your main JIRA issue,
>> >> SCXML-116 [4] as described in this email [5]. In particular, see the
>> >> ATTIC-1 example mentioned in that email. I think such a task list may
>> >> also help in your GSoC progress reports later.
>> >>  * One of the first tasks, then, may be abouting posting your starter
>> >> code into SVN. For that task, attach a zip containing the source you
>> >> want added to SVN and I will check it in. Please use the coding style
>> >> that is used in Commons SCXML code. Its pretty much the "Sun
>> >> conventions" [6], but when in doubt, please check the SCXML sources
>> >> for consistency.
>> >>  * Further changes may then be supplied as patches [7] to the above.
>> >>
>> >> Let us know if any of this needs more clarification, or if there are
>> >> other questions.
>> >>
>> >> -Rahul
>> >>
>> >> [1] http://markmail.org/thread/vrgis2xli3iofapd
>> >> [2] http://commons.apache.org/#The_Commons_Sandbox
>> >> [3] http://commons.apache.org/sandbox/
>> >> [4] https://issues.apache.org/jira/browse/SCXML-116
>> >> [5] http://markmail.org/message/hunh4xaoag3wiimu
>> >> [6] http://java.sun.com/docs/codeconv/html/CodeConvTOC.doc.html
>> >> [7] http://commons.apache.org/patches.html
>> >>
>> >>
>> >> > Best Regards
>> >> >
>> >> > Long
>> >> >
>> >> > 在 2010年5月2日 下午2:05,Rahul Akolkar <rahul.akolkar@gmail.com>写道:
>> >> >
>> >> >> Hi Long,
>> >> >>
>> >> >> You can simply send emails to the Commons dev mailing list (rather
>> >> >> than to me and CC'ing the list). I read mostly all emails on the
>> >> >> list,
>> >> >> and especially those related to SCXML or GSoC.
>> >> >>
>> >> >> 2010/4/29 Xun Long Gui <ustbcoder@gmail.com>:
>> >> >> > Hi Rahul,
>> >> >> > Althrough Google told us that students should start coding
job at
>> >> >> > May
>> >> 25,
>> >> >> > but i think, for me and this project, it is time to move now.
>> >> >> <snip/>
>> >> >>
>> >> >> OK, that date is just a guideline really, its upto you.
>> >> >>
>> >> >>
>> >> >> > I think this
>> >> >> > tool is not a simple tool, two months long time is not enough
>> >> actually. I
>> >> >> > started coding experience job weeks ago and got a demo about
this
>> >> >> project,
>> >> >> > but it is just a demo, if we want to make it well developed
and
>> >> >> practical,
>> >> >> > it is a simple thing. Now, here is my develop plan, we should
>> >> >> > finish
>> >> it
>> >> >> step
>> >> >> > by step, there are mainly four steps in all.
>> >> >> >
>> >> >> > Step 1. Finish basic data model design, create a visual state
>> >> >> > add/edit/delete tool
>> >> >> > We can use GMF to generate many codes for this tool, but the
>> >> >> >  premise
>> >> is
>> >> >> > that we must have a correct EMF data model about this tool.
For
>> >> example,
>> >> >> > only if we have a ASSIGN STATE in this data model,  then we
can
>> >> >> > find a
>> >> >> > ASSIGN STATE component in toolbar of final editor. As we know,
a
>> >> >> > SCXML
>> >> >> > document has only one START state, if we make wrong in the
EMF
>> >> >> > data
>> >> >> model,
>> >> >> > may be in the final editor, we can add several START states
for a
>> >> SCXML
>> >> >> > document, obviously, it is wrong.
>> >> >> >
>> >> >> > So,EMF data model is very important for a GMF visual editor,
and
>> >> >> > SCXML
>> >> >> > specification is not a simple specification, i should read
it
>> >> carefully
>> >> >> and
>> >> >> > even get a proper data model for this project. Fortunately,
i have
>> >> >> cleaned
>> >> >> > all the technology difficulites in this period. I need just
time
>> >> >> > to
>> >> >> finish
>> >> >> > this period. I think it will cost me 5-6 weeks.
>> >> >> >
>> >> >> <snap/>
>> >> >>
>> >> >> Yes, getting the EMF model correct is ofcourse important. If you
>> >> >> think
>> >> >> its a good idea, it may be better to make some editor function
>> >> >> available much sooner than 5 weeks (perhaps with a smaller feature
>> >> >> set) and then improve it or complete the coverage for the SCXML
>> >> >> specification. So, we may simply start with what you have in your
>> >> >> demo, get it in SVN now or within a few days (by submitting a patch
>> >> >> in
>> >> >> JIRA) and have others try it out while you make improvements.
>> >> >>
>> >> >> In general, I think its better to get in the habit of making
>> >> >> incremental changes and SVN commits. Not only does this allow other
>> >> >> developers here to follow what you are doing, but will also be
>> >> >> useful
>> >> >> during your mid-summer and end of summer progress reports and
>> >> >> deliverables for GSoC.
>> >> >>
>> >> >>
>> >> >> > Step 2. SCXML document export and import function
>> >> >> > After we finish a SCXML document edit job in this tool, we
should
>> >> export
>> >> >> it
>> >> >> > to a XML format document, this is a data model to xml document
>> >> >> > job,
>> >> not
>> >> >> very
>> >> >> > hard.
>> >> >> >
>> >> >> > Also, we should supplies SCXML document import function, users
use
>> >> this
>> >> >> tool
>> >> >> > to import existing SCXML document, then edit, and export it
again.
>> >> >> > I
>> >> >> think
>> >> >> > this is also a regular job process.
>> >> >> >
>> >> >> <snip/>
>> >> >>
>> >> >> If we can get a usable level of round-tripping between the SCXML
>> >> >> serialization and the editor (editor -> XML -> editor as
well as XML
>> >> >> -> editor -> XML style scenarios), that'd be nice indeed.
>> >> >>
>> >> >>
>> >> >> > In this period, we should finish some Eclipse extension point
>> >> >> implemention
>> >> >> > job as well as data model to XML transfer job, it will cost
me 2-3
>> >> weeks.
>> >> >> >
>> >> >> > Step 3. Degug function
>> >> >> > It is hard to finish a fantastic debug tool, especially in
such a
>> >> short
>> >> >> > time. But at least, i will finsih state logic check part for
this
>> >> tool.
>> >> >> For
>> >> >> > example, if there is a dead loop in the state transition diagram,
>> >> >> > this
>> >> >> tool
>> >> >> > will give user some tips and warnings.
>> >> >> >
>> >> >> > Step 4. Code generation function
>> >> >> > If we have time left, i want to finish JAVA code generation
job
>> >> >> > for
>> >> this
>> >> >> > tool. It will generate JAVA classes with the same function
with
>> >> editing
>> >> >> > SCXML document.
>> >> >> >
>> >> >> <snap/>
>> >> >>
>> >> >> OK, would you like to start documenting (perhaps on the wiki) the
>> >> >> plans for Steps 3 and 4 in more detail over the next couple of
>> >> >> weeks?
>> >> >> We can always revise the estimates later based on progress in Steps
>> >> >> 1
>> >> >> and 2 and the time those take. Will also help to start brainstorming
>> >> >> suitable approaches towards implementing these.
>> >> >>
>> >> >>
>> >> >> > Rahul, as you pointed before, Step 1 and 2 are the core components
>> >> >> > for
>> >> >> this
>> >> >> > tool, so i will pay much attention to this two parts, if we
can
>> >> >> > finish
>> >> >> these
>> >> >> > two parts well, many people will benefit from this tool. I
want to
>> >> >> > contribute this tool to Apache Commons SCXML project as a
beta
>> >> >> > publish
>> >> >> > version once i finish these two steps. Then,more user and
>> >> >> > developers
>> >> can
>> >> >> > find it in Apache web site, may be they can also give us some
good
>> >> >> advises
>> >> >> > to improve it.
>> >> >> >
>> >> >> > Step 3 and 4 is extend functions for this tool, it will make
this
>> >> >> > tool
>> >> >> > better, but these two parts exist in my brain only, i have
not
>> >> >> > done
>> >> any
>> >> >> > experiments to get right ways to impelent them. I will try
my best
>> >> >> > to
>> >> >> finish
>> >> >> > them well, may be in Google Summer Code time, i can not finish
>> >> >> > them,
>> >> but
>> >> >> i
>> >> >> > will still work for them.
>> >> >> >
>> >> >> > This is my plan, your opinion ? Thank you !
>> >> >> <snip/>
>> >> >>
>> >> >> See comments above. Thanks for getting started :-)
>> >> >>
>> >> >> -Rahul
>> >> >>
>> >> >>
>> >> >> > --
>> >> >> > Best Regards
>> >> >> >
>> >> >> > Gui Xun Long (桂训龙)
>> >> >> >
>> >> >
>> >> >
>> >> > --
>> >> > Best Regards
>> >> >
>> >> > Gui Xun Long (桂训龙)
>> >> >
>> >>
>
>
>
> --
> Best Regards
>
> Gui Xun Long (桂训龙)
>

---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscribe@commons.apache.org
For additional commands, e-mail: dev-help@commons.apache.org


Mime
View raw message