Skip to content

Commit de97982

Browse files
jslvtrjslvtr
jslvtr
authored and
jslvtr
committed
Add CONTRIBUTING file for those who want to add to this code. Updated README so it's better for GitHub.
1 parent d772a1e commit de97982

File tree

2 files changed

+43
-38
lines changed

2 files changed

+43
-38
lines changed

Diff for: CONTRIBUTING.md

+40
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,40 @@
1+
# Course template
2+
3+
## Set up project
4+
5+
Make sure you have Python3.7 installed.
6+
7+
Then, in a terminal, run:
8+
9+
```
10+
pipenv install
11+
```
12+
13+
### Set up Git Hooks
14+
15+
We have a Git hook config that will run Black formatter on all modified files **before you commit**—that's in case you forget to do so yourself or don't have your IDE set up to format on save (which you should, Black is unintrusive!).
16+
17+
To set up the Git hook:
18+
19+
```
20+
pipenv shell
21+
pre-commit install
22+
```
23+
24+
The first time you commit it may take a little longer than you'd hope, but subsequent commits will be quicker.
25+
26+
> Commits will **fail** if any files are formatted, but the files will still be formatted. This is so you are aware of the reformat and also so we don't accidentally reformat something we don't want to reformat.
27+
28+
If you want to run the commit without running the hook, do `git commit --no-verify`. This is highly discouraged, we should be aiming for consistent code, and using a formatter really helps us achieve that!
29+
30+
## allow_prereleases
31+
32+
The Pipfile has `allow_prereleases = "true"` because for Black this is required. Make sure when installing libraries that the latest stable version is used, but try to avoid using alpha and beta versions where possible.
33+
34+
There are times where it will be unavoidable to use prerelease versions of libraries used in a course to teach actual content. We should discuss them on an individual basis. The reason for this is that if we cover an alpha version of a library, it's likely it will change by the time the course is released.
35+
36+
## Creating course documentation
37+
38+
Internal course documentation (for recording purposes) should go in Notion ((https://www.notion.so/teclado/Course-Wikis-fdd4b72cb5f74e1a9d7172f03e5c24cd)[https://www.notion.so/teclado/Course-Wikis-fdd4b72cb5f74e1a9d7172f03e5c24cd]).
39+
40+
If there is documentation or files that students would benefit from having, they should be included in this repository alongside the code.

Diff for: README.md

+3-38
Original file line numberDiff line numberDiff line change
@@ -1,40 +1,5 @@
1-
# Course template
1+
# Python Refresher
22

3-
## Set up project
3+
This repository contains our Python Refresher or Reference code, ordered by lecture.
44

5-
Make sure you have Python3.7 installed.
6-
7-
Then, in a terminal, run:
8-
9-
```
10-
pipenv install
11-
```
12-
13-
### Set up Git Hooks
14-
15-
We have a Git hook config that will run Black formatter on all modified files **before you commit**—that's in case you forget to do so yourself or don't have your IDE set up to format on save (which you should, Black is unintrusive!).
16-
17-
To set up the Git hook:
18-
19-
```
20-
pipenv shell
21-
pre-commit install
22-
```
23-
24-
The first time you commit it may take a little longer than you'd hope, but subsequent commits will be quicker.
25-
26-
> Commits will **fail** if any files are formatted, but the files will still be formatted. This is so you are aware of the reformat and also so we don't accidentally reformat something we don't want to reformat.
27-
28-
If you want to run the commit without running the hook, do `git commit --no-verify`. This is highly discouraged, we should be aiming for consistent code, and using a formatter really helps us achieve that!
29-
30-
## allow_prereleases
31-
32-
The Pipfile has `allow_prereleases = "true"` because for Black this is required. Make sure when installing libraries that the latest stable version is used, but try to avoid using alpha and beta versions where possible.
33-
34-
There are times where it will be unavoidable to use prerelease versions of libraries used in a course to teach actual content. We should discuss them on an individual basis. The reason for this is that if we cover an alpha version of a library, it's likely it will change by the time the course is released.
35-
36-
## Creating course documentation
37-
38-
Internal course documentation (for recording purposes) should go in Notion ((https://www.notion.so/teclado/Course-Wikis-fdd4b72cb5f74e1a9d7172f03e5c24cd)[https://www.notion.so/teclado/Course-Wikis-fdd4b72cb5f74e1a9d7172f03e5c24cd]).
39-
40-
If there is documentation or files that students would benefit from having, they should be included in this repository alongside the code.
5+
Feel free to bookmark or download this code to come back to it at a later date!

0 commit comments

Comments
 (0)