Reply New Topic
2007/12/8 18:27:40
#1
Offline
Home away from home

Using the trackers to document changes in the SVN

Hi guys,

In order to better document and follow up the changes we do in our SVN, what do you think about the following.

Before coding something new of fixing a bug, we add an item either in the bug tracker, or the feature tracker, or for larger things, in the task tracker.

Then we code it, commit it, and make sure to link our SVN commit message with the ID of the item we created.

That way, changes will truly be documented and opened for commenting by other developer which is a very good thing.

For example, yesterday, I added the multilanguage feature. I did not add an item in the tracker. So today I found out 2 things.

1- Rodriguo already did something similar in Xoopers.
2- I forgot to change the install process to add the new config options in the databse, same thing for the upgrade script.

If I had added a task or feature requesy at SF for this, may Rodriguo could have told me he already did it, and david and nekro could have documented that it was not working.

I'm going to add a task for the ML now

Thoughts ?


2007/12/8 18:50:39
#2
Offline
Home away from home

Re: Using the trackers to document changes in the SVN

I agree with this - if I had posted that I was working on the system templates, it would have eliminated a conflict that arose when the latest 2.0.18rc changes were committed.

Let's give it a start

_________________
Christian Web Resources
Facebook

2007/12/9 4:31:15
#3
Offline
Home away from home

Re: Using the trackers to document changes in the SVN

+1


2007/12/9 12:26:57
#4
Offline
Home away from home

Re: Using the trackers to document changes in the SVN

gets my vote.

simplicity at it's best :)

_________________
Live as if you were to die tomorrow, Learn as if you were to live forever

The beauty of a living thing is not the atoms that go into it, but the way those atoms are put together!

2007/12/10 6:40:44
#5
Offline
Home away from home

Re: Using the trackers to document changes in the SVN

Ok good, we have started to use it. I saw others here have started to use it and I'm very glad !

Please document as much as possible everything you do with the tracker.

I also have another request. When one fixed a bug documented in the bug tracker, when you close the bug item, please post a message to document what you did, something like :
Quote:

Fixed and committed, revision XX


Where XX us the revision number associated with your changes.

And of course, in your commit message, you would have written something like :
Quote:

Fixing bug #12346 by implementing blablabla


That way, the bug and the fix are linked in 2 ways.

Any objection ?

Thanks !

_________________
Marc-André Lanciault
Founder and CEO INBOX International inc.
Co-Founder ImpressCMS

2007/12/19 13:28:14
#6
Offline
Home away from home

Re: Using the trackers to document changes in the SVN

I have another request for the trackers - since we have several branches under active development, please indicate which branch produced the bug.

I think it was Dave that mentioned in another forum the first thing he does with a bug is try to reproduce it so he can validate it.

Our SVN repository is growing rapidly with new branches and tasks, so keeping ourselves very organized and maintaining the documentation is vital to our progress.

Should we create a group for each branch?

_________________
Christian Web Resources
Facebook

2007/12/19 15:22:44
#7
Offline
Home away from home

Re: Using the trackers to document changes in the SVN

Good idea


2007/12/19 17:51:24
#8
Offline
Quite a regular

Re: Using the trackers to document changes in the SVN

Great important idea for developing!


2007/12/19 19:54:29
#9
Offline
Home away from home

Re: Using the trackers to document changes in the SVN

Quote:

I have another request for the trackers - since we have several branches under active development, please indicate which branch produced the bug.


Absolutely.

Quote:

Should we create a group for each branch?


Yes. If anyone sees a group (branch, releases) or category that is not present in the tracker, please post here and someone with access will create them.

_________________
Marc-André Lanciault
Founder and CEO INBOX International inc.
Co-Founder ImpressCMS

Reply New Topic extras
 Previous Topic   Next Topic
You can view topic.
You can start a new topic.
You can reply to posts.
You cannot edit your posts.
You cannot delete your posts.
You cannot add new polls.
You cannot vote in polls.
You cannot attach files to posts.
You can post without approval.