update: Improve onboarding documentation and include lessons learned from customer projects.

This commit is contained in:
Jan Jambor 2024-05-14 17:12:01 +02:00
parent 439f90cbff
commit 1592680085
5 changed files with 38 additions and 6 deletions

View file

@ -3,3 +3,26 @@
Initial setup instructions for development environments.
List and explanation of development tools used in our team.
We should automate this as much as possible e.g. by providing an ansible playbook.
## Setup git
As we are relying on tracability, we are enforcing the use of proper usernames in git. If you are only working with Ypsomed repositories, you can use the following commands to set up your global git configuration:
```bash
git config --global user.name "FIRST_NAME LAST_NAME"
git config --global user.email "ABBREVIATION@ypsomed.com"
```
If you are also working in other contexts, it is recommended to purge the global configuration and set it up for each repository individually. You can do this by running the following commands once:
```bash
git config --global --unset user.name
git config --global --unset user.email
```
And then in each repository set up individual configuration:
```bash
git config user.name "FIRST_NAME LAST_NAME"
git config user.email "ABBREVIATION@ypsomed.com"
```