search

IRNAS / irnas-guidelines-docs

This repository contains guidelines related to various aspects of managing GitHub repositories at IRNAS and working with them.
Other
2 stars 1 forks source link

Add sections about styles, documentation specific to each programming language #26

Closed MarkoSagadin closed 2 years ago

MarkoSagadin commented 2 years ago

This PR adds sections about coding styles, documentation guidelines, specific language constructs for C/C++, Python, Rust and Bash.

Please review Programming language specifics . Commits section will be complete when #25 is merged into dev and dev back into this branch.

I have also added docs/source_code_templates, with files that can serve as a starting point for C/C++ and Python. Feedback is appreciated, I have run the text through Grammarly, so grammatical errors should be minimal.

SloMusti commented 2 years ago

I would suggest all lines of coding requirements also include a short example, for example comments around a c function or such. This will make things a lot clearer.

MarkoSagadin commented 2 years ago

@SloMusti I agree, I will add good examples.

MarkoSagadin commented 2 years ago

@TjazVracko I agree with the snippet, many things that are inside this document should be supported by tools (like snippets in VSCode).

However, I would like to place such tools into a separate repo meant for the developer setup.

MarkoSagadin commented 2 years ago

I will merge this although JS/TS section is not done yet. It will be filled in later.