New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Contributing guidelines need to be extended #20

Open

spectralcode opened this issue Jul 3, 2022 · 0 comments

Owner

spectralcode commented Jul 3, 2022

The contributing guidelines should contain a style guide and/or some more infos about coding standards.

Some things to consider:

every header file should have at least one brief comment to explain what the use of the file/class is
create an overview document that explains the code structure of the software and add a link to it in the contributing guidelines
use some ideas from the Mantid project coding standards: https://www.mantidproject.org/C++_Coding_Standards

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment