# Coding guideline

**URL:** https://discourse.paraview.org/t/coding-guideline/10649
**Category:** Development
**Created:** [November 1, 2022, 6:49pm UTC](https://discourse.paraview.org/t/coding-guideline/10649 "2022-11-01T18:49:12Z")
**Posts on this page:** 4
**Page:** 1

<div class="post-metadata">

### Author: ![Fabian](https://discourse.paraview.org/letter_avatar_proxy/v4/letter/f/f6c823/32.png) [@Fabian](https://discourse.paraview.org/u/Fabian)
#### Post date: [November 1, 2022, 6:49pm UTC](https://discourse.paraview.org/t/coding-guideline/10649/1 "2022-11-01T18:49:12Z")

</div>

We are happy that our CFSReader plugin got integrated and we very much appreciate the help and support of the kitware guys - with very special thanks to Mathieu but also to Ben and Cory.

I offer to add to the documentation some guidelines I learned during the review process. My idea is we briefly discuss here the approach and location, I would then make a suggestion via a merge request and leave it to you, if you are interested in using it or not.

One location would be within paraview in Documentation/dev/git/develop.md  
[https://gitlab.kitware.com/paraview/paraview/-/blob/master/Documentation/dev/git/develop.md](https://gitlab.kitware.com/paraview/paraview/-/blob/master/Documentation/dev/git/develop.md)

The other location (which I did not know about before) is within vtk Documentation/dev/git/review.md either based on the master or in Ben’s merge request  
[https://gitlab.kitware.com/ben.boeckel/vtk/-/blob/mr-checklist/Documentation/dev/git/review.md](https://gitlab.kitware.com/ben.boeckel/vtk/-/blob/mr-checklist/Documentation/dev/git/review.md)

My suggestion is to have it for paraview but link to vtk.

What I extracted is basically not that much, following the above suggestion, I would remove what is already in vtk.

---

<div class="post-metadata">

### Author: ![mwestphal](https://discourse.paraview.org/user_avatar/discourse.paraview.org/mwestphal/32/17_2.png) [@mwestphal](https://discourse.paraview.org/u/mwestphal)
#### Post date: [November 1, 2022, 11:49pm UTC](https://discourse.paraview.org/t/coding-guideline/10649/2 "2022-11-01T23:49:54Z")

</div>

You are very much welcome to do so and I’ll be happy to review 🙂

---

<div class="post-metadata">

### Author: ![Fabian](https://discourse.paraview.org/letter_avatar_proxy/v4/letter/f/f6c823/32.png) [@Fabian](https://discourse.paraview.org/u/Fabian)
#### Post date: [November 3, 2022, 11:36pm UTC](https://discourse.paraview.org/t/coding-guideline/10649/3 "2022-11-03T23:36:42Z")

</div>

Thanks 🙂

This is my proposal [https://gitlab.kitware.com/paraview/paraview/-/merge\_requests/5998](https://gitlab.kitware.com/paraview/paraview/-/merge_requests/5998)

I realized that the style guide of VTK’s develop.md is only in Ben’s branch but not on VTK’s master. I did not want to refer to a merge request and therefore created a file guidelines.md which could be extended/merged and referred also from VTK.

There is some more content in Ben’s branch but I did not want to copy it but partially the instructions overlap. For my description I skipped what is enforced via clang-format from the robot anyway.

Feel free to use the proposal, not use it or ask me for some changes 🙂

With respect to the guidelines, this is purely what I extracted from the reviews - it is not my ideas and actually quite different from my style of own code.

---

<div class="post-metadata">

### Author: ![mwestphal](https://discourse.paraview.org/user_avatar/discourse.paraview.org/mwestphal/32/17_2.png) [@mwestphal](https://discourse.paraview.org/u/mwestphal)
#### Post date: [August 17, 2023, 9:41am UTC](https://discourse.paraview.org/t/coding-guideline/10649/4 "2023-08-17T09:41:28Z")

</div>

The guide has been merged!