Skip to content
Snippets Groups Projects
Commit 75d71215 authored by Felix Wege's avatar Felix Wege
Browse files

Update default branch name in README

parent ff8aa4a9
No related branches found
No related tags found
No related merge requests found
...@@ -9,20 +9,20 @@ InEEd-DC Model Library - **!! SHORT DESCRIPTION TO BE DONE !!** ...@@ -9,20 +9,20 @@ InEEd-DC Model Library - **!! SHORT DESCRIPTION TO BE DONE !!**
If you want to contribute to the InEEd-DC Model Library, please follow the rules and guidelines specified below: If you want to contribute to the InEEd-DC Model Library, please follow the rules and guidelines specified below:
### Branches ### Branches
- All developing works should be done in personal branchs or feature branches. Please follow the name guidelines for creating new branches: `dev_<NameAbbr>` or `dev_<feature>`. - All developing works should be done in personal branchs or feature branches. Please follow the name guidelines for creating new branches: `dev_<NameAbbr>` or `dev_<feature>`.
- Merge requests to the `master` branch should be coordinated with other developers in advance. - Merge requests to the `main` branch should be coordinated with other developers in advance.
- The master branch will be updated at least every two weeks. - The main branch will be updated at least every two weeks.
### Mergen into master branch ### Merge into main branch
For the update process (mergen) of master branch, the following instruction in 7 Steps has been presented and should be followed: For the update process (mergen) of main branch, the following instruction in 7 Steps has been presented and should be followed:
| Step | discription | | Step | discription |
| ------ | ------ | | ------ | ------ |
| Step 1 | pull master branch (remote) | | Step 1 | pull main branch (remote) |
| Step 2 | merge master branch (local) in MyFeature branch (local) and solve merge-conflicts in MyFeature branch | | Step 2 | merge main branch (local) in MyFeature branch (local) and solve merge-conflicts in MyFeature branch |
| Step 3 | test the MyFeature branch (local) by its functionality | | Step 3 | test the MyFeature branch (local) by its functionality |
| Step 4 | merge MyFeature branch (local) in master branch (local) | | Step 4 | merge MyFeature branch (local) in main branch (local) |
| Step 5 | test the master branch (local) by its functionality | | Step 5 | test the main branch (local) by its functionality |
| Step 6 | commit MyFeature branch (local) and push MyFeature branch to remote | | Step 6 | commit MyFeature branch (local) and push MyFeature branch to remote |
| Step 7 | submit a merge request from MyFeature branch (remote) to master branch (remote) | | Step 7 | submit a merge request from MyFeature branch (remote) to main branch (remote) |
Importance: Importance:
- On principle, only functional codes can be merged. If this is not the case, put WIP (Work in progress) in the title of merge request. - On principle, only functional codes can be merged. If this is not the case, put WIP (Work in progress) in the title of merge request.
...@@ -30,7 +30,7 @@ Importance: ...@@ -30,7 +30,7 @@ Importance:
- Always use merge request to update work, so that the working history is tracable. - Always use merge request to update work, so that the working history is tracable.
### Environment File ### Environment File
- The environment file in the `master` branch should always be synchronized with the program and should be updated simultaneously with other files. - The environment file in the `main` branch should always be synchronized with the program and should be updated simultaneously with other files.
- In order to keep the used third-party packages in a reasonable size, it is necessary to stay conservative when adding new packages. - In order to keep the used third-party packages in a reasonable size, it is necessary to stay conservative when adding new packages.
### Modeling Language ### Modeling Language
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Please register or to comment