current PCL development guidelines

classic Classic list List threaded Threaded
4 messages Options
Reply | Threaded
Open this post in threaded view
|

current PCL development guidelines

Radu B. Rusu
Administrator
Hi All,

The pool of PCL developers is growing quickly, as more of you got access to the repository now in order to be able to
commit code. I thought this would be a good time to iterate over a brief list of guidelines, so that we make sure that
our code is easily readable, etc

* if you make any commits, please add the commit log or something similar to the changelist page:
http://www.ros.org/wiki/point_cloud_perception/ChangeList

* if you change anything in an existing algorithm, make sure that there are unit tests for that and make sure that they
pass before you commit the code

* if you add a new algorithm or method, please document the code as the existing PCL code (or better! :) ), and add some
minimal unit test

* method definitions go into (include/.h), templated implementations go into (src/.hpp), non-templated implementations
go into (src/.cpp), unit tests go in (test/*.cpp)

* last but not least, please respect the same naming and indentation guidelines as you see in PCL (also presented in the
roscpp documentation)

* <add more here if you feel like it>

If everyone is ok with this list, we'll add it to the wiki.

Thanks,
Radu.

_______________________________________________
[hidden email] / http://pcl.ros.org
https://code.ros.org/mailman/listinfo/pcl-users
Reply | Threaded
Open this post in threaded view
|

Re: current PCL development guidelines

Radu B. Rusu
Administrator
ping. :) It seems that quite a few people forget to add their changes to

http://www.ros.org/wiki/point_cloud_perception/ChangeList

Please do so, as otherwise it's hard to keep track what's going on. If someone wants to generate a list of SVN commits
and parse those out to the web using a script, that works for me too.

Cheers,
Radu.


On 09/23/2010 11:34 AM, Radu Bogdan Rusu wrote:

> Hi All,
>
> The pool of PCL developers is growing quickly, as more of you got access
> to the repository now in order to be able to commit code. I thought this
> would be a good time to iterate over a brief list of guidelines, so that
> we make sure that our code is easily readable, etc
>
> * if you make any commits, please add the commit log or something
> similar to the changelist page:
> http://www.ros.org/wiki/point_cloud_perception/ChangeList
>
> * if you change anything in an existing algorithm, make sure that there
> are unit tests for that and make sure that they pass before you commit
> the code
>
> * if you add a new algorithm or method, please document the code as the
> existing PCL code (or better! :) ), and add some minimal unit test
>
> * method definitions go into (include/.h), templated implementations go
> into (src/.hpp), non-templated implementations go into (src/.cpp), unit
> tests go in (test/*.cpp)
>
> * last but not least, please respect the same naming and indentation
> guidelines as you see in PCL (also presented in the roscpp documentation)
>
> * <add more here if you feel like it>
>
> If everyone is ok with this list, we'll add it to the wiki.
>
> Thanks,
> Radu.
>
_______________________________________________
[hidden email] / http://pcl.ros.org
https://code.ros.org/mailman/listinfo/pcl-users
Reply | Threaded
Open this post in threaded view
|

Re: current PCL development guidelines

Brian Gerkey
On Thu, Oct 14, 2010 at 9:38 AM, Radu Bogdan Rusu <[hidden email]> wrote:
> ping. :) It seems that quite a few people forget to add their changes to
>
> http://www.ros.org/wiki/point_cloud_perception/ChangeList
>
> Please do so, as otherwise it's hard to keep track what's going on. If someone wants to generate a list of SVN commits
> and parse those out to the web using a script, that works for me too.

I would recommend against scripting it.  A ChangeList that is simply a
transformation of the SVN logs is not useful.  The value comes from
the developers' taking the time to highlight the key changes that
users might care about.  E.g., if a bug got fixed over several
commits, I just want to know that the bug was fixed, maybe with a
reference to the ticket that pointed out the bug.

I think that we do a pretty good job of maintaining a useful
ChangeList for ROS, e.g.:

http://www.ros.org/wiki/ROS/ChangeList/1.2

        brian.
_______________________________________________
[hidden email] / http://pcl.ros.org
https://code.ros.org/mailman/listinfo/pcl-users
Reply | Threaded
Open this post in threaded view
|

Re: current PCL development guidelines

Radu B. Rusu
Administrator
Sorry, I meant a _separate_ web page for the SVN commits, not SVN comits -> ChangeList (good God, have you looked at my
svn commit comments sometimes? :) ). This would allow us to formulate the ChangeList faster, and would allow people to
see what's going on in trunk.

I know this information exists on every project at code.ros.org. If there is a way to extract this from there, that
would be great. But I haven't found a good way to do this per stack. The Search Criteria at
https://code.ros.org/gf/project/ros-pkg/search/ doesn't work for me, or I don't know what to enter there.


Cheers,
Radu.


On 10/14/2010 09:52 AM, Brian Gerkey wrote:

> On Thu, Oct 14, 2010 at 9:38 AM, Radu Bogdan Rusu<[hidden email]>  wrote:
>> ping. :) It seems that quite a few people forget to add their changes to
>>
>> http://www.ros.org/wiki/point_cloud_perception/ChangeList
>>
>> Please do so, as otherwise it's hard to keep track what's going on. If someone wants to generate a list of SVN commits
>> and parse those out to the web using a script, that works for me too.
>
> I would recommend against scripting it.  A ChangeList that is simply a
> transformation of the SVN logs is not useful.  The value comes from
> the developers' taking the time to highlight the key changes that
> users might care about.  E.g., if a bug got fixed over several
> commits, I just want to know that the bug was fixed, maybe with a
> reference to the ticket that pointed out the bug.
>
> I think that we do a pretty good job of maintaining a useful
> ChangeList for ROS, e.g.:
>
> http://www.ros.org/wiki/ROS/ChangeList/1.2
>
> brian.
_______________________________________________
[hidden email] / http://pcl.ros.org
https://code.ros.org/mailman/listinfo/pcl-users