Theaninova/openstapps
1
0
Fork 0
mirror of https://gitlab.com/openstapps/openstapps.git synced 2026-01-10 03:32:52 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

docs: add minor tweaks to project docs

Browse Source
This commit is contained in:
Karl-Philipp Wulfert
2018-12-06 14:36:36 +01:00
parent f81be04e22
commit 4b23f8cd7e
5 changed files with 23 additions and 14 deletions
Download Patch File Download Diff File Expand all files Collapse all files

4
project-docs/workflow/CODING.md
View File

@@ -4,7 +4,9 @@ These guidelines are meant for TypeScript based project but can be adapted for p
## Configuration
Consistent code structure and style is ensured by using [`@openstapps/configuration`](https://gitlab.com/openstapps/configuration/blob/master/README.md). It contains configuration files for your editor, the TypeScript compiler and TSLint.
Consistent code structure and style is ensured by using [`@openstapps/configuration`](https://gitlab.com/openstapps/configuration). It contains configuration files for your editor, the TypeScript compiler and TSLint.
When you install this project and are missing any of the recommended configuration files, they will be automatically created for you.
## Comments

11
project-docs/workflow/COMMITS.md
View File

@@ -2,9 +2,9 @@
## Template
Commit messages should match the following template:
Commit subjects should match the following template:
> `TYPE`: `MESSAGE`
> `TYPE`: `SUBJECT`
>
> `DESCRIPTION`
@@ -26,11 +26,11 @@ Commit messages should match the following template:
These are the [types](https://github.com/angular/angular/blob/master/CONTRIBUTING.md#type), that angular uses. They are easily adaptable for all TypeScript based web related projects.
### `MESSAGE`
### `SUBJECT`
`MESSAGE` should complete a sentence that starts with "This commit will...".
`SUBJECT` should be written in the imperative mood. You can think of a short subject that completes a sentence that starts with "This commit will...".
The first line of the commit message should not be longer than 50 chars overall.
The first line of the commit subject should not be longer than 50 chars overall.
### `DESCRIPTION`
@@ -56,4 +56,5 @@ conventional-changelog -p angular -i CHANGELOG.md -s -r 0
## Further resources
* [Recommendations on commit messages](https://chris.beams.io/posts/git-commit/)
* [Versioning](VERSIONING.md)