Best Practices

 

Table of Contents

Introduction
General considerations
    Use issues to discuss any intended modifications
    Document your code
    Coding style
Git tips for developers
Git tips for maintainers

Introduction

This page gather instructions for developers to contribute in a clean and smooth way to the SPECFEM3D package. These are, in general, not new rules to those familiar with software development.

General considerations

Use issues to discuss any intended modifications

GitHub provides a system to track issues. It should be a central place to monitor SPECFEM3D evolution. In particular:

• Report bug as they occur.
• Plan modifications.

Document your code

Any new code should be fully Doxygen commented. If you have some free time, feel free to comment any code you modify.

Coding style

Be consistent with the file you are modifying. It might be best to keep line length under a reasonable number (80, 100? -- to be determined).

Git tips for developers

We adopt an Integration-Manager workflow which requires some attention for developers to contribute to. Tips and helpful commands useful for SPECFEM developers are describe on the Git tips for developers page.

Git tips for maintainers

Maintainers of the SPECFEM packages find tips and helpful commands on the Git tips for maintainers page.