Skip to content

Commit 6daa9d8

Browse files
Merge pull request ml-archive#101 from nodes-vapor/siemensikkema-patch-1
Add some clarifications and cleanups to Vapor setup
2 parents 1f54ffe + 04ddda0 commit 6daa9d8

File tree

1 file changed

+6
-4
lines changed

1 file changed

+6
-4
lines changed

Documentation/how-to-start-a-project.md

Lines changed: 6 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -43,6 +43,7 @@ Have a look at this [template](https://github.com/nodes-projects/readme/blob/mas
4343

4444
```
4545
[Swift version] [Vapor version]
46+
4647
`master`: [Circle CI] [Codebeat]
4748
`develop`: [Circle CI] [Codebeat]
4849
```
@@ -51,7 +52,7 @@ See some of the other projects on the nodes-projects organization for comparison
5152

5253
#### Branches
5354

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:
5556

5657
- [x] "Protect this branch"
5758
- [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
6970
[![Circle CI](https://circleci.com/gh/nodes-projects/my-project/tree/master.svg?style=shield&circle-token=my-token)](https://circleci.com/gh/nodes-projects/my-project)
7071
```
7172

73+
> 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+
7275
### Codebeat
7376

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.
7578

7679
### Deployment
7780

@@ -97,5 +100,4 @@ Test: http://codepen.io/dennishn/pen/BLbYyJ
97100

98101
### Storage
99102

100-
If you need to store files, e.g. images, the [Storage](
101-
https://github.com/nodes-vapor/storage) package is here to help you.
103+
If you need to store files, e.g. images, the [Storage](https://github.com/nodes-vapor/storage) package is here to help you.

0 commit comments

Comments
 (0)