You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: short_courses/data_science_best_practices.md
+5-5Lines changed: 5 additions & 5 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -26,10 +26,10 @@ While it is not essential to follow every recommendation to the letter, thoughtf
26
26
27
27
## Quick-start
28
28
29
-
Most of the instructions in this guide require use of the commandline interface in a Unix based system (Mac and Linux). For use with Windows first install Gitbash via [Git for Windows](gitforwindows.org).
29
+
Most of the instructions in this guide require use of the commandline interface in a Unix based system (Mac and Linux). For use with Windows first install Gitbash via [Git for Windows](https://gitforwindows.org).
30
30
Where `{project-name}` is referenced, replace this with the name of your project _without_ the curly braces.
31
31
32
-
To get started you will need to make sure [Python](<README#Language: Python>), [Git](<README#Version Control: Git>) and [Poetry](<README#Packaging and Dependency Management: Poetry>) are installed.
32
+
To get started you will need to make sure [Python](#language-python), [Git](#version-control-git) and [Poetry](#packaging-and-dependency-management-poetry) are installed.
33
33
Python and Git come pre-installed on both Mac and Linux systems, and Git is installed as part of Git for Windows, but Windows users will need to [download](https://www.python.org/downloads/) and install Python.
34
34
You will need to additionally install Poetry, which can be done from the [website](https://python-poetry.org/) or by running:
35
35
@@ -95,7 +95,7 @@ poetry add {package-name}
95
95
96
96
### Writing Code:
97
97
98
-
We recommend writing the majority of code using [VSCode](<README#IDE: VSCode>) which will need [installing]() on all systems
98
+
We recommend writing the majority of code using [VSCode](#ide-vscode) which will need [installing](https://code.visualstudio.com/Download) on all systems
99
99
Core project code can be added to a new `module_name.py` file in `src/{project-name}/` and then functions, classes and variables from that module can be imported into other files using:
100
100
101
101
```python
@@ -142,7 +142,7 @@ Git is often pre-installed on macOS and Linux systems, allowing users to start u
142
142
143
143
A .gitignore file is a simple text file used in Git repositories to specify which files and directories should be ignored by Git. This is essential for excluding unnecessary files (like build artifacts, compiled code, and sensitive information) from version control, keeping the repository clean and reducing clutter. By listing patterns in .gitignore, you ensure that specified files won’t be tracked, staged, or committed. Common entries include temporary files, system files, and virtual environment directories (e.g., .venv/, \*.log, **pycache**/).
144
144
145
-
A lot of the content for the `.gitignore` is standard boilerplate which does not change between projects, and there are useful [generators](https://www.toptal.com/developers/gitignore/) to help build comprehensive files. An example `.gitignore` file has been included [here](./.gitignore).
145
+
A lot of the content for the `.gitignore` is standard boilerplate which does not change between projects, and there are useful [generators](https://www.toptal.com/developers/gitignore/) to help build comprehensive files.
146
146
147
147
## Project Structure
148
148
@@ -193,7 +193,7 @@ NOTE: files beginning `.` are hidden files and will not appear unless showing hi
193
193
ls -A
194
194
```
195
195
196
-
## README: README.md
196
+
## README: README.md {#readme-readmemd}
197
197
198
198
A well-structured README file is essential for providing users with clear instructions about the project. It should give an overview of the project, installation steps, usage instructions, and contribution guidelines. README.md file should be written in [markdown](https://www.markdownguide.org/), and contain basic project information, installation instructions and links to associated publications.
0 commit comments