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: Documentation/how-to-start-a-project.md
+6-4Lines changed: 6 additions & 4 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -43,6 +43,7 @@ Have a look at this [template](https://github.com/nodes-projects/readme/blob/mas
43
43
44
44
```
45
45
[Swift version] [Vapor version]
46
+
46
47
`master`: [Circle CI] [Codebeat]
47
48
`develop`: [Circle CI] [Codebeat]
48
49
```
@@ -51,7 +52,7 @@ See some of the other projects on the nodes-projects organization for comparison
51
52
52
53
#### Branches
53
54
54
-
After the repository has been created and Circle CI (see [Circle CI](#circle-ci) section) has been setup, go to the "Settings" part of the repository and hit "Branches". In here you want to make sure that `develop` is set as the default branch and that `master` and `develop` are added as protected branches. For each protected branch make sure that the following options are checked:
55
+
After the repository has been created and Circle CI (see [Circle CI](#circle-ci) section) has been set up, go to the "Settings" part of the repository on Github and hit "Branches". In here you want to make sure that `develop` is set as the default branch and that `master` and `develop` are added as protected branches. For each protected branch make sure that the following options are checked:
55
56
56
57
-[x] "Protect this branch"
57
58
-[x] "Require status checks to pass before merging"
@@ -69,9 +70,11 @@ Last step is to generate a token for the Circle CI badge for the readme. Select
> Note that in order to create the badge for the develop environment you first have to trigger a Circle CI build on develop by pushing a commit.
74
+
72
75
### Codebeat
73
76
74
-
We use Codebeat for static code analysis. Although the reports and the GPA score should be taken with a grain of salt, the reports are still useful for getting recommendations for areas to improve in the codebase. Each repository and branch needs to be setup manually. After logging into Codebeat (please reach out to a fellow developer for credentials) you can add the `master` and `develop` branches for the repository. When Codebeat is done analyzing, the badges for the readme will be available under "Settings" within the different reports.
77
+
We use Codebeat for static code analysis. Although the reports and the GPA score should be taken with a grain of salt, the reports are still useful for getting recommendations for areas to improve in the codebase. Each repository and branch needs to be set up manually. After logging into Codebeat (please reach out to a fellow developer for credentials) you can add the `master` and `develop` branches for the repository. When Codebeat is done analyzing, the badges for the readme will be available under "Settings" within the different reports.
0 commit comments