DLR-AMR / t8code

Parallel algorithms and data structures for tree-based AMR with arbitrary element shapes.

Home Page:https://dlr-amr.github.io/t8code/

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

More detail on contributing

jwallwork23 opened this issue · comments

The "Contributing" section at the start of CONTRIBUTING.md is very brief. It would be beneficial to provide a little more detail on:
a) How to contact principal developers (if you want to make a large contribution).
b) Provide a link to the coding guidelines wiki page.
c) Whether there are requirements for all new contributions to be tested and documented. I notice there is a wiki page on this but it isn't linked from CONTRIBUTING.md nor the coding guidelines wiki page.

(Part of JOSS review openjournals/joss-reviews#6887.)

Thank you for this input.

It is very beneficial for us to have a good CONTRIBUTING file.
We will adress your changes.

Please see #1172. I hope i addressed all your concerns.
I added further info, linked the Wiki article on Coding guidelines and also updated the Wiki article.

Issue got closed automatically but id like to wait for your feedback before closing.

Please see #1172. I hope i addressed all your concerns. I added further info, linked the Wiki article on Coding guidelines and also updated the Wiki article.

Thanks for addressing this - it's really useful to have this extra detail. Happy for this issue to be closed.