Skip to content

Commit ba494c5

Browse files
eriktkssverhoeven
andauthored
Apply suggestions from code review
Co-authored-by: Stefan Verhoeven <stefan.verhoeven@gmail.com>
1 parent 29514ae commit ba494c5

1 file changed

Lines changed: 7 additions & 5 deletions

File tree

ADD_TO_EXISTING_PACKAGE.md

Lines changed: 7 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,17 +1,19 @@
11
# Add your existing code to directory generated by the NLeSC Python template
22

3+
The following steps require you existing code to be in a GitHub repository already.
4+
35
1. Follow the [instructions to create a new package](https://github.com/NLeSC/python-template#how-to-use) with the Python template, while answering the questions like you would for the existing package.
46

5-
2. Create a Git structure for the new directory: (replace the capitalized name by your own)
7+
2. Create a Git structure for the new directory: (replace `<NEW_DIRECTORY>` with directory name you used during cookiecutter questionnaire)
68
```shell
7-
$ cd NEW_DIRECTORY
9+
$ cd <NEW_DIRECTORY>
810
$ git init
911
$ git add --all
10-
$ git commit -m "first commit"
12+
$ git commit -m "Added code generated by cookiecutter"
1113
$ git branch -M main
1214
```
1315

14-
3. Import the existing repository from Github (Replace `<ORGANIZATION>` with your GitHub organization name , `REPOSITORY` with your GitHub repository name and `<BRANCH>` with your default branch for example `main` or `master`):
16+
3. Import the existing repository from GitHub (Replace `<ORGANIZATION>` with your GitHub organization name , `<REPOSITORY>` with your GitHub repository name and `<BRANCH>` with your default branch for example `main` or `master`):
1517
```shell
1618
$ git remote add -f existing_code https://github.com/<ORGANIZATION>/<REPOSITORY>
1719
$ git fetch existing_code
@@ -22,6 +24,6 @@ $ git merge existing_code/<BRANCH> --allow-unrelated-histories
2224
5. Add all the files to GitHub:
2325
```shell
2426
$ git add --all
25-
$ git commit -m "Merged existing code with code generated by `cookiecutter https://github.com/NLeSC/python-template`"
27+
$ git commit -m "Merged existing code with code generated by cookiecutter"
2628
$ git push
2729
```

0 commit comments

Comments
 (0)