|
Page Edited :
OPENEJB :
Tips and Suggestions
Tips and Suggestions has been edited by Vamsavardhana Reddy (Sep 09, 2007). Content:Useful information for new committersCommitsContributed by: David Blevins I generally try never to reformat a file and make changes at the same time as it makes it impossible for anyone to see what I've changed. Needle in a haystack. I try to get the reformatting as its own commit before or after I change a file. A lot of times I end up tweaking a bunch of little unrelated things while working on a bigger change. I tend to like to "clear them out" in separate commits as to isolate the big change in one commit. Sometimes I'm not so good at that and other times I'm really meticulous about it. Include the JIRA number and title (if there is a jira). I try never to say "Fixed FOO-2543" all by itself. Reviewing the last 10 changes on a file is a super big PITA when all you see is numbers to other systems. I shoot for more or less "Fixed <issue-number> <issue-title> <how-did-i-fix-it>" Sometimes the "how did i fix it" part is obvious by the title, other times not. Sometimes I'm too tired and the wife is impatiently waiting for me to leave the computer As far as jiras go, there doesn't have to be a jira for absolutely every commit – what's the point of that. I try to make sure there's a jira for anything we'd definitely want to see in the release notes. Sometimes I don't get the jira created till long after the change, towards release time when creating the release notes As far as jira titles, I always try and make them short and succinct for the future release notes. SVN + JIRAContributed by: Vamsi I had trouble figuring out if a revision is related to a JIRA and what all revisions corresponded to a particular JIRA. So, I always include the JIRA number (if there is an associated JIRA) in the svn comment and once committed, I add the revision number to the JIRA comment. It may be a minute or two more to do this. But, it saves a lot of time if you ever have to investigate a regression or if there are multiple revisions for a JIRA you know where to find the revision numbers instead of having to mine the svn logs. scp, ssh, and rsync examples for working with files and directories on people.apache.orgContributed by: David Blevins copying a file to apache from locahost copying a file from apache to localhost – reverse of the above copying directories When the directory exists, better to rsync pull a dir from apache the two above commands do the exact same thing push the same dir to apache the two above commands do the exact same thing sometimes useful to execute commands over ssh (piping works too) A cool subversion tipContributed by: Jacek Laskowski. It'll let you forget about some svn administrative commands you'd otherwise have to type in on the command line. \[miscellany\] global-ignores = *.log *.save *.o *.lo *.la #*# .*~ *~ .#* .DS_Store build dist target *.ipr *.iml *.iws .project .classpath .settings enable-auto-props = yes \[auto-props\] *.c = svn:eol-style=native;svn:keywords=Date Author Id Revision HeadURL *.cpp = svn:eol-style=native;svn:keywords=Date Author Id Revision HeadURL *.h = svn:eol-style=native;svn:keywords=Date Author Id Revision HeadURL *.dsp = svn:eol-style=CRLF *.dsw = svn:eol-style=CRLF *.sh = svn:executable;svn:eol-style=native;svn:keywords=Date Revision *.cmd = svn:mime-type=text/plain;svn:eol-style=CRLF *.bat = svn:mime-type=text/plain;svn:eol-style=CRLF Makefile = svn:eol-style=native;svn:keywords=Date Author Id Revision HeadURL *.obj = svn:mime-type=application/octet-stream *.bin = svn:mime-type=application/octet-stream *.bmp = svn:mime-type=image/bmp *.class = svn:mime-type=application/java *.doc = svn:mime-type=application/msword *.exe = svn:mime-type=application/octet-stream *.gif = svn:mime-type=image/gif *.gz = svn:mime-type=application/x-gzip *.jar = svn:mime-type=application/java-archive *.jelly = svn:mime-type=text/plain;svn:eol-style=native;svn:keywords=Date Revision *.jpg = svn:mime-type=image/jpeg *.jpeg = svn:mime-type=image/jpeg *.pdf = svn:mime-type=application/pdf *.png = svn:mime-type=image/png *.tgz = svn:mime-type=application/octet-stream *.tif = svn:mime-type=image/tiff *.tiff = svn:mime-type=image/tiff *.zip = svn:mime-type=application/zip *.txt = svn:mime-type=text/plain;svn:eol-style=native;svn:keywords=Date Revision *.xml = svn:mime-type=text/xml;svn:eol-style=native;svn:keywords=Date Revision *.ent = svn:mime-type=text/plain;svn:eol-style=native;svn:keywords=Date Revision *.dtd = svn:mime-type=text/plain;svn:eol-style=native;svn:keywords=Date Revision *.vsl = svn:mime-type=text/plain;svn:eol-style=native;svn:keywords=Date Revision *.xsd = svn:mime-type=text/xml;svn:eol-style=native;svn:keywords=Date Revision *.xsl = svn:mime-type=text/xml;svn:eol-style=native;svn:keywords=Date Revision *.wsdl = svn:mime-type=text/xml;svn:eol-style=native;svn:keywords=Date Revision *.htm = svn:mime-type=text/html;svn:eol-style=native;svn:keywords=Date Revision *.html = svn:mime-type=text/html;svn:eol-style=native;svn:keywords=Date Revision *.css = svn:mime-type=text/css;svn:eol-style=native;svn:keywords=Date Revision *.js = svn:mime-type=text/plain;svn:eol-style=native;svn:keywords=Date Revision *.jsp = svn:mime-type=text/plain;svn:eol-style=native;svn:keywords=Date Revision *.txt = svn:mime-type=text/plain;svn:eol-style=native;svn:keywords=Date Revision *.java = svn:mime-type=text/plain;svn:eol-style=native;svn:keywords=Date Revision *.properties = svn:mime-type=text/plain;svn:eol-style=native;svn:keywords=Date Revision *.sql = svn:mime-type=text/plain;svn:eol-style=native;svn:keywords=Date Revision |
Unsubscribe or edit your notifications preferences
