Welcome to CHIME Software Guidelines

Overview

guidelines is a repository containing tutorials and guidelines for the CHIME organization's software, as recommended by the project office. Topics include:

• Learning the Linux shell
• Using SSH remote connection
• Implementing Git version control (repos -> orgs -> projects)
• Creating Git changes (issues -> branches -> pull-requests -> actions -> releases)
• Coding with a VSCode text editor
• Learning the development process (Poetry -> Precommit -> Commitizen)
• Using a production environment (CI/CD -> Docker)
• Adding important features to your code (CLIs -> logging -> documentation -> tests)
• Interfacing with Sanic servers
• Working with the CANFAR network

In each section, on the right of your screen, you'll see a Table of Contents that allows you to navigate to each section in each topic. Be sure to read all the main topics on the left, and all their sections on the right :).

Feedback

Feedback is most definitely welcome! If you have any suggestion on the improvement of these guidelines, please make a Git Issue describing the changes that you'd like made.