|
|
Geometry : |
Subject: Re: [geometry] Boost.Geometry contribution tutorial
From: Adam Wulkiewicz (adam.wulkiewicz_at_[hidden])
Date: 2014-05-22 07:16:50
Menelaos Karavelas wrote:
> Hi Adam.
>
> On 22/05/2014 03:06 ??, Adam Wulkiewicz wrote:
>> 2014-05-21 12:51 GMT+02:00 Adam Wulkiewicz <adam.wulkiewicz_at_[hidden]
>> <mailto:adam.wulkiewicz_at_[hidden]>>:
>>
>> 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.
>
Done.
Ok so I'd like to move this tutorial to the wiki. To do this I need a
place for pics.
Do we also want to put developers guidelines and/or GitHub tutorial in
the docs (which means putting the images somewhere in docs) or should
they stay only in the Wiki (which means creating an empty branch 'wiki'
and putting the images there)?
I'd probably vote for option 2. Plus adding direct links to Guidelines
and Contribution Tutorial in the README.
Regards,
Adam
Geometry list run by mateusz at loskot.net