Theaninova/openstapps
1
0
Fork 0
mirror of https://gitlab.com/openstapps/openstapps.git synced 2026-01-10 19:52:53 +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

12
CONTRIBUTING.md
View File

@@ -1,16 +1,16 @@
# How to contribute # How to contribute
To contribute effectively to this or other Open StApps projects you should read the documentation in this repository To contribute effectively to this or other Open StApps projects you should read the documentation in this repository first.
* What's the scope of one [project](../project-docs/workflow/PROJECT.md)? * What's the scope of one [project](../project-docs/workflow/PROJECT.md)?
* How to create [issues](../project-docs/workflow/ISSUES.md) in projects. * How to create [issues](../project-docs/workflow/ISSUES.md) in projects.
* How to [set up](../project-docs/SETUP.md) your machine? * How to [set up](../project-docs/SETUP.md) your machine?
* How to contribute code? * How to contribute code?
* What's the [branching model](../project-docsworkflow/BRANCHING.md)? * What's the [branching model](../project-docsworkflow/BRANCHING.md)?
* How to write [code](../project-docs/workflow/CODING.md)? * How to write [code](../project-docs/workflow/CODING.md)?
* How to create [merge requests](../project-docs/workflow/MERGING.md)? * How to create [merge requests](../project-docs/workflow/MERGING.md)?
* How to write [documentation](../project-docs/workflow/DOCUMENTATION.md)? * How to write [documentation](../project-docs/workflow/DOCUMENTATION.md)?
* How to [version](../project-docs/workflow/VERSIONING.md) the code? * How to [version](../project-docs/workflow/VERSIONING.md) the code?
## Further resources ## Further resources

4
project-docs/DOCKER_CHEAT_SHEET.md
View File

@@ -32,10 +32,14 @@ docker exec -it $CONTAINERID $PROGRAM
## Tidy system ## Tidy system
This removes unused images, networks, ... from your system.
``` ```
docker system prune docker system prune
``` ```
Please consult the [Docker documentation](https://docs.docker.com/engine/reference/commandline/system_prune/) for more information.
## Further resources ## Further resources
* [An Exhaustive Guide to Writing Dockerfiles for Node.js Web Apps](https://blog.hasura.io/an-exhaustive-guide-to-writing-dockerfiles-for-node-js-web-apps-bbee6bd2f3c4) * [An Exhaustive Guide to Writing Dockerfiles for Node.js Web Apps](https://blog.hasura.io/an-exhaustive-guide-to-writing-dockerfiles-for-node-js-web-apps-bbee6bd2f3c4)

6
project-docs/SETUP.md
View File

@@ -8,6 +8,8 @@
* Node.js & NPM - be sure to install the current LTS version, might need a [PPA](https://github.com/nodesource/distributions/blob/master/README.md#installation-instructions) * Node.js & NPM - be sure to install the current LTS version, might need a [PPA](https://github.com/nodesource/distributions/blob/master/README.md#installation-instructions)
* [NVM](https://github.com/creationix/nvm#installation) - if you want to use multiple different versions of node * [NVM](https://github.com/creationix/nvm#installation) - if you want to use multiple different versions of node
Example for Debian based distributions:
```shell ```shell
apt install ssh git docker docker-compose nodejs apt install ssh git docker docker-compose nodejs
``` ```
@@ -19,8 +21,8 @@ apt install ssh git docker docker-compose nodejs
## Optional helpful tools ## Optional helpful tools
* Curl - for executing HTTP requests * Curl - for executing HTTP requests on the command line
* Postman or Insomnia * Postman or Insomnia - for executing HTTP requests with a GUI
## Clone starter repositories ## Clone starter repositories

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 ## 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 ## Comments

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

@@ -2,9 +2,9 @@
## Template ## Template
Commit messages should match the following template: Commit subjects should match the following template:
> `TYPE`: `MESSAGE` > `TYPE`: `SUBJECT`
> >
> `DESCRIPTION` > `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. 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` ### `DESCRIPTION`
@@ -56,4 +56,5 @@ conventional-changelog -p angular -i CHANGELOG.md -s -r 0
## Further resources ## Further resources
* [Recommendations on commit messages](https://chris.beams.io/posts/git-commit/)
* [Versioning](VERSIONING.md) * [Versioning](VERSIONING.md)