Have code for NCCR CLIM+ research?
Explore the C2SM NCCR CLIM+ project on GitHub
Browse C2SM's shared project repository.
Request a repository for your code in the C2SM NCCR CLIM+ project on GitHub
Provide us with information to set up your repository.
Guidelines
| ✓ | Use version control (e.g., git) for your code. |
| ✓ | Add a README to the repository that explains how to run your code. If applicable, include information about the environment your code runs in. |
| ✓ | Add a license to your code repository. We recommend an Open Source License, e.g., BSD-3-Clause. |
| × | Don’t include data, log, or backup files in your Git repositories. |
| 👍 | Separate configuration from methods. Avoid hardcoding paths to private directories. |
| 👍 | Separate input data and code. Design your code to be run by anyone in any directory. |
| 👍 | Write functions for repeated operations and call them in your code. |
| 👍 | Initiate and participate in "code reviews" with your colleagues. |
Recommended resources
C2SM Data and Code Management Recommendations
Practical recommendations for managing research data.
C2SM Coding Best Practices
Guidance on Git workflows, automated testing, and useful tools for coding.