I can remember that someone started a JBoss developer guidelines but what
happens to that.
I think we should create a small developer guidelines containing infos like:
- logging changes
- writting/updating JavaDoc
- writting/updating Manuals
- other guidelines but I would suggest to keep them really simple
Mad Andy
----- Original Message -----
From: "marc fleury" <[EMAIL PROTECTED]>
To: <[EMAIL PROTECTED]>
Sent: Wednesday, June 13, 2001 6:30 PM
Subject: RE: Commit Messages was [RE: [JBoss-dev] CVS update:
jboss/src/main/org/jboss/ejb CacheKey.java]
> So we are back to putting the comments in by hand then.
>
> I agree that logs can be "bulk".
>
>
> we NEED to keep track of WHO changed WHAT in a given file.
>
> The format should be
>
> date-author: changes
>
>
> e.g.
>
>
> 2001/07/08: mfleury: Changed method Foo to take the right by copy
parameter
>
>
> and the author tag identifies me so you can write to me, any *real*
> complaints?
>
> marcf
>
>
> |-----Original Message-----
> |From: [EMAIL PROTECTED]
> |[mailto:[EMAIL PROTECTED]]On Behalf Of Scott
> |M Stark
> |Sent: Wednesday, June 13, 2001 9:24 PM
> |To: [EMAIL PROTECTED]
> |Subject: Re: Commit Messages was [RE: [JBoss-dev] CVS update:
> |jboss/src/main/org/jboss/ejb CacheKey.java]
> |
> |
> |Yes, we can include the cvs commit msg in the code but I'm not in favor
of
> |it. At best it reproduces the comments that should be in the code
> |out of context.
> |In general it gives a higher level description of a change that
> |was made across
> |several files that were bulk commited.
> |
> |There are also known issues with use of the $Log$ keyword to
> |include the comments
> |causing problems during merges.
> |
> |> that it goes way beyond the original team (it is happening *right now*)
I
> |> believe we should really enforce "the comments in the code". Yes I
know
> |> that the logs are what are supposed to keep that but frankly I
> |would rather
> |> see it all in one place, ie. at the top of the file to see who has done
> |> what, since it gets very confusing and you have to be online to get
that
> |> information through cvs.
> |>
> |> I am open to that one, how do you guys feel? (do you feel
> |strongly against
> |> it? I remember one of you feeling strongly) but frankly more than once
I
> |> read code and I go, huh? where does that come from... that would be
very
> |> useful.
> |>
> |> Is there a way to have cvs include the commits messages automatically?
> |>
> |
> |
> |
> |_______________________________________________
> |Jboss-development mailing list
> |[EMAIL PROTECTED]
> |http://lists.sourceforge.net/lists/listinfo/jboss-development
>
>
>
> _______________________________________________
> Jboss-development mailing list
> [EMAIL PROTECTED]
> http://lists.sourceforge.net/lists/listinfo/jboss-development
>
_______________________________________________
Jboss-development mailing list
[EMAIL PROTECTED]
http://lists.sourceforge.net/lists/listinfo/jboss-development
