This lesson is still being designed and assembled (Pre-Alpha version)

Sustainable Software Development: Glossary

Key Points

Introduction
  • We are not professional software engineers but software is important.

  • Our code is very likely to be shared with our colleagues.

Useful Documents
  • Start paying attention to good coding practice.

  • There are experts willing to help!

Use GitLab Wisely
  • Commit often.

  • Write informative commit messages.

We Like Portable Code
  • Use relative path and environment variables.

  • Test it often.

  • Use CI.

We Like Short Code
  • Use existing libraries if we can.

  • Create common functions if we need them very often.

  • Split if certain blocks become monstrous.

Design Your Package
  • Modeling is the designing of software applications before coding.

  • Layout the diagrams on paper.

  • Think about the expected users.

  • Consolidating standalone scripts.

  • Modeling is the designing of software applications before coding.

Subtle Things That Make Our Lives Better
  • Add comments in your code.

  • Use variable/function/file names that are easy to interpret.

Summary
  • Long term gain.

Glossary

Quotes and screenshots are taken from colleagues that are willing to share.