Skip to content

Commit cdc4c09

Browse files
committed
docs: fix step ordering, add GitHub account requirement, clarify git init
1 parent 913a6cb commit cdc4c09

File tree

1 file changed

+70
-33
lines changed

1 file changed

+70
-33
lines changed

README.md

Lines changed: 70 additions & 33 deletions
Original file line numberDiff line numberDiff line change
@@ -38,6 +38,8 @@ Every project generated from this template includes:
3838

3939
## Requirements
4040

41+
### Tools
42+
4143
Before using this template, make sure you have the following installed:
4244
```bash
4345
# Copier -- the tool that renders the template
@@ -50,13 +52,27 @@ brew install poetry
5052
git --version
5153
```
5254

53-
### One-time Git configuration (if not already done)
55+
### GitHub account
56+
57+
You will need a GitHub account to push your projects to remote repositories
58+
and to use GitHub Actions for CI/CD. If you do not have one, create one at
59+
[github.com](https://github.com) before proceeding.
60+
61+
### One-time Git configuration
62+
63+
Run these once on your machine. They apply globally to all Git repositories
64+
you create going forward:
5465
```bash
5566
git config --global user.name "Your Name"
5667
git config --global user.email "your@email.com"
5768
git config --global init.defaultBranch main
5869
```
5970

71+
The `init.defaultBranch main` setting ensures every new repository starts on
72+
`main` rather than `master`. This is important because the template's CI/CD
73+
pipeline is configured around `main`, `uat`, and `dev` branches. Once this is
74+
set globally you never need to rename branches after `git init`.
75+
6076
### Recommended Poetry configuration
6177

6278
This tells Poetry to create virtualenvs inside the project folder as `.venv/`
@@ -115,7 +131,7 @@ Python version
115131
> 3.13
116132
117133
Short project description
118-
> Analysis of exchange rate pass-through to core inflation
134+
> Analysis of exchange rate pass-through to local core inflation
119135
120136
License (MIT / Apache-2.0 / Proprietary)
121137
> MIT
@@ -198,6 +214,58 @@ your-project-name/
198214
VS Code will detect `.venv/` automatically and use it as the Python
199215
interpreter for the project.
200216

217+
### Step 5 -- Initialise Git
218+
219+
Before installing pre-commit hooks, Git must be initialised in the project.
220+
```bash
221+
git init
222+
```
223+
224+
Because you set `init.defaultBranch main` globally in the one-time Git
225+
configuration, the repository will already start on `main` -- no renaming
226+
needed. You can confirm with:
227+
```bash
228+
git branch
229+
```
230+
231+
### Step 6 -- Install pre-commit hooks
232+
```bash
233+
poetry run pre-commit install
234+
```
235+
236+
This activates the pre-commit hooks so that every time you run `git commit`,
237+
Ruff and Mypy run automatically and block the commit if there are any issues.
238+
You only need to run this once per project, immediately after `git init`.
239+
240+
### Step 7 -- Confirm everything is working
241+
```bash
242+
make ci
243+
```
244+
245+
If this passes with no errors, your project is fully set up and ready for
246+
development.
247+
248+
### Step 8 -- Push to GitHub
249+
250+
Create a new empty repository on GitHub first:
251+
252+
1. Go to [github.com/new](https://github.com/new)
253+
2. Name it to match your project name (e.g. `inflation-db`)
254+
3. Leave it completely empty -- no README, no .gitignore, no license
255+
4. Click Create repository
256+
257+
Then back in your terminal:
258+
```bash
259+
git add .
260+
git commit -m "feat: initial project setup"
261+
git remote add origin https://github.com/YOUR-USERNAME/your-project-name.git
262+
git push -u origin main
263+
```
264+
265+
Replace `YOUR-USERNAME` with your GitHub username. After this your project
266+
is on GitHub with CI/CD active -- every push will trigger the Actions
267+
pipeline automatically.
268+
201269
---
202270

203271
## Default packages
@@ -292,37 +360,6 @@ poetry show
292360

293361
---
294362

295-
### Step 5 -- Install pre-commit hooks
296-
```bash
297-
poetry run pre-commit install
298-
```
299-
300-
This activates the pre-commit hooks so that every time you run `git commit`,
301-
Ruff and Mypy run automatically and block the commit if there are any issues.
302-
You only need to run this once per project, after cloning or generating it.
303-
304-
### Step 6 -- Confirm everything is working
305-
```bash
306-
make ci
307-
```
308-
309-
If this passes with no errors, your project is fully set up and ready for
310-
development.
311-
312-
### Step 7 -- Initialise Git and push to GitHub
313-
```bash
314-
git init
315-
git branch -m master main
316-
git add .
317-
git commit -m "feat: initial project setup"
318-
319-
# Create a new empty repo on GitHub (no README, no .gitignore), then:
320-
git remote add origin https://github.com/KyleFe/your-project-name.git
321-
git push -u origin main
322-
```
323-
324-
---
325-
326363
## Generated project structure
327364
```
328365
your-project-name/

0 commit comments

Comments
 (0)