User Guide of the Canoe Model

The following articles step sets the basics of properly using the Canoe repo.

Contents

• Article 1: Workflow
  • Step 1. Submit an issue ticket on the GitHub website
  • Step 2. Create a new branch locally
  • Step 3. Use the .gitignore file
  • Step 4. Add changed files to git
  • Step 5. Commit your changes locally
  • Step 6. Upload your branch to GitHub
  • Step 7. Submit a pull request (PR)
  • Step 8. Update your local branch
• Article 2: git-send and git-done
  • Step 1. Creating a file for our command
  • Step 2. Add custom commands to $PATH
  • Step 3. Running our custom command
  • The git-done command
• Article 3: How to give names
  • How to name folders and files
  • How to name variables and classes
  • How to name funcions
• Article 4: Git Tips
• Article N: Troubleshooting
  • Trouble 1. Cannot fetch RFM
  • Trouble 2. Cannot fetch RFM in Github actions