mirror of
https://gitlab.com/openstapps/openstapps.git
synced 2026-01-09 19:22:51 +00:00
docs: add minor tweaks to project docs
This commit is contained in:
@@ -1,6 +1,6 @@
|
||||
# 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)?
|
||||
* How to create [issues](../project-docs/workflow/ISSUES.md) in projects.
|
||||
|
||||
@@ -32,10 +32,14 @@ docker exec -it $CONTAINERID $PROGRAM
|
||||
|
||||
## Tidy system
|
||||
|
||||
This removes unused images, networks, ... from your system.
|
||||
|
||||
```
|
||||
docker system prune
|
||||
```
|
||||
|
||||
Please consult the [Docker documentation](https://docs.docker.com/engine/reference/commandline/system_prune/) for more information.
|
||||
|
||||
## 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)
|
||||
|
||||
@@ -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)
|
||||
* [NVM](https://github.com/creationix/nvm#installation) - if you want to use multiple different versions of node
|
||||
|
||||
Example for Debian based distributions:
|
||||
|
||||
```shell
|
||||
apt install ssh git docker docker-compose nodejs
|
||||
```
|
||||
@@ -19,8 +21,8 @@ apt install ssh git docker docker-compose nodejs
|
||||
|
||||
## Optional helpful tools
|
||||
|
||||
* Curl - for executing HTTP requests
|
||||
* Postman or Insomnia
|
||||
* Curl - for executing HTTP requests on the command line
|
||||
* Postman or Insomnia - for executing HTTP requests with a GUI
|
||||
|
||||
## Clone starter repositories
|
||||
|
||||
|
||||
@@ -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
|
||||
|
||||
|
||||
@@ -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)
|
||||
|
||||
Reference in New Issue
Block a user