Hi Adam.

On 22/05/2014 03:06 πμ, Adam Wulkiewicz wrote:
2014-05-21 12:51 GMT+02:00 Adam Wulkiewicz <adam.wulkiewicz@gmail.com>:
Hi,

Barend Gehrels wrote:

This is a (very clear) technical description. I think we should add one or two things in the section "Modify the branch":

It now contains "At this point it's up to you what to do with your new branch." which is fine.

But I think we should add some hint that if people create a new feature, or a bugfix, or some parts for the docs, or an example, it is often wise to consult the mailing list if that is a good idea. Maybe other people are working on the same thing too. If it is a larger feature it is good to post a sort of implementation plan to check if the feature, and the implementation, is what is expected.


Thanks for the suggestion. I fixed it (and other minor things).


Also we should refer to the coding guidelines.

Good idea, however for now the guidelines are only in the QBK form, right?
We could think about moving them to the Wiki (or duplicate and keep in both places).

https://github.com/boostorg/geometry/wiki/Guidelines-for-Developers
 

In the last code snippet, I would also add the DOXYGEN_NO_* macros.

- m.

I'm also not sure if keeping those 4 chapters from docs in the Wiki is a good idea. It could serve us rather to comunicate with the contributors when the docs is used to communicate with the users. The Wiki theoretically could be more dynamic than docs which should be rather persistent.
And of course in both places (doc and wiki) there should be links pointing to each other.

Regards,
Adam




_______________________________________________
Geometry mailing list
Geometry@lists.boost.org
http://lists.boost.org/mailman/listinfo.cgi/geometry