Recommended Coding Practices

We are not professional coders, but we all must code to survive! 💻🌟

Image by Johnson Martin from Pixabay

In this Recommended Coding Practices repository you will find introductory and broad material to start developing code following good practices. Feel free to explore the contents of this repo; re-use it in whichever way you want; and contribute or provide feedback on it 🙌✨🤝

---

The material was originally designed for researchers within the Department of Aerospace Structures and Materials of the Faculty of Aerospace Engineering (AE) of the Technische Universiteit Delft (TU Delft) in The Netherlands.

---

Practice and enjoy! 💻🌟

Contents

In this repository you will find the following material:

• Unix Shell Bash commands 🖥️
• Environment variables 📜
• Aliases 🧙
• Version control with Git 📌
• Project structure recommendations 🗂️
• Coding conventions 🧹
• Naming conventions ✍️
• Code documentation 📝
• Guidelines on what to do once you finish a project 🚀

If you are already familiar with some of the material, you can go directly to the cheatsheets and the templates 🧠🔖:

• Bash Cheatsheet
• Git Cheatsheet
• README templates for data, code and machine-learning projects.
  • The README for a data repository (README_data.txt) is in .txt format. Fill it in according to what is asked in commented text (in between <!--- and -->). Then rename the file as README.txt and put it at the top-level of the data/ directory.
  • The README for a code repository (README_code.md) and machine-learning projects (README_ML.md) are written in Markdown. Use the Code tab instead of the Preview tab to see the commented text. Fill in the template according to what is asked in commented text (in between <!--- and -->). Then rename the file as README.md and keep it at the top-level of the project repository.

How to follow the material? 🧠

The material is presented in separate Markdown files. In order to go through the material, follow the numerical order of the names of the files. At the end of each page you will also find the Previous and Next links that will take you through the material in sequential order.

Author

Dr. Heather Andrews Mancilla (@HeatherAn, 0000-0002-6637-2830, H.E.AndrewsMancilla@tudelft.nl, Technische Universiteit Delft

License

The contents of this repository are released under a Creative Commons Attribution 4.0 International License (CC-BY-4.0).

References

The material has re-used part of the content provided by open sources such as the Software Carpentry and Code Refinery initiatives.

Would you like to contribute? ✨

Found an error? 🐛 or would like to make a suggestion? 💡 Feel free to open an issue!

Want to improve the content? 💻 You are more than welcome to do so! Feel free to fork the repo and submit a pull request. Do you need a reminder on how to fork? Check out the forking material here 😉

---

Next : 01 - Unix Shell commands