Development Guidelines

[fabian-hk]

I have summarized our discussion around the development of DY* from the last meeting in the [Development.md](Development.md) file. Feel free to add things if you think something is missing. I am also not sure if this is the right place to have this information. Maybe it is better to have them in the README (or at least reference them there) or put them into a pinned Issue. @TWal, what are your thoughts?

[TWal]

Thanks, it looks good! I think this information is usually in a file named CONTRIBUTING.md?

Another thing we didn't discuss, in the code I tried to have some rigor in the formatting, e.g. every let is preceded by a val (although they could be merge into one big let), and also used generously newlines in the val to help make it more readable (everything in one line is fine when the signature is small, but as it gets bigger adding newlines really helps readability). Should we also document this somewhere and ask contributors to follow these guidelines, or should we accept that DY has diverse formatting? Unfortunately, there are no formatters for F…

[fabian-hk]

Yes I have recognized that you follow a certain style guide. I think that is important for the code quality so it makes sense to add this style guide in the file. Do you want to rename it to CONTRIBUTING.md and add a style guide section?

[TWal]

Yes, I will do that!

[TWal]

I have put many guidelines for proof hygiene and code formatting, does it look good?

[fabian-hk]

It looks good and can be merged from my side. I fixed a small typo in the last commit. We should link the CONTRIBUTING.md file in the README. What do you think?

[TWal]

Thanks! I switch the CODEOWNERS to a team so that we don't need to change this file each time we need to add a new owner.