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: README.md
+22-6Lines changed: 22 additions & 6 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,5 +1,4 @@
1
-
SatO Telegram Bot
2
-
=================
1
+
# SatO Telegram Bot
3
2
4
3
This bot has some useful functionality for Satakuntalainen Osakunta. It can be found on Telegram as `@osakuntabot`.
5
4
@@ -10,9 +9,27 @@ Available commands:
10
9
/ruokalista
11
10
/tjviisi
12
11
12
+
## Development
13
13
14
-
Development
15
-
-----------
14
+
⚠️⚠️ Read the entirety of this section before making changes to the repository ⚠️⚠️
15
+
16
+
### Development flow
17
+
18
+
1. Always create a new branch for whatever you are working on
19
+
2. When you're done, create a pull request
20
+
3. Check the preview for what changes will be done upon deployment
21
+
4. If everything looks good, merge the pull request and the changes will be automatically done
22
+
23
+
### Warnings
24
+
25
+
The code in the `master` branch is automatically deployed. Therefore you should be careful as to what you merge to this branch.
26
+
27
+
Changes to the `infra/` directory modify the resources that are deployed on the cloud. These can incur extra cost if you are not careful.
28
+
Changes to the application source code (`main.py`, `telegram_bot/`) can also incur costs if they run for long or consume a lot of resources (processor time, bandwidth)
29
+
30
+
Be mindful to the changes you make. You can ask for help and comments on your pull request before merging. After large changes, monitor the costs incurred manually on the cloud dashboard.
31
+
32
+
### Local development
16
33
17
34
Get `pipenv` from [here](https://pipenv.pypa.io/en/latest/)
18
35
@@ -30,5 +47,4 @@ You can test the commands on commandline by:
30
47
31
48
python main.py /command [args]
32
49
33
-
The bot is hosted in Google Cloud Functions and CircleCI is used to continuously deploy new versions of the bot to GCP.
34
-
NB! If you add dependencies to the project, remember to generate a new requirements.txt with `pipenv lock -r` and push it to the repo. Pipfile is not supported by Google Cloud Functions.
50
+
NB! If you add dependencies to the project, remember to generate a new requirements.txt with `pipenv requirements > requirements.txt` and push it to the repo. Pipfile is not supported by Google Cloud Functions.
0 commit comments