Skip to content

Commit

Permalink
chore: update configuration library standard (#406)
Browse files Browse the repository at this point in the history
Co-authored-by: Miguel de Barros <[email protected]>
  • Loading branch information
kleyow and mdebarros authored Mar 7, 2023
1 parent f3c0604 commit 068c33b
Showing 1 changed file with 8 additions and 8 deletions.
16 changes: 8 additions & 8 deletions docs/community/standards/guide.md
Original file line number Diff line number Diff line change
Expand Up @@ -49,7 +49,7 @@ The following runtime standards are utilizes for Mojaloop.
RUN ln -sf /dev/stdout ./logs/combined.log
# Create a non-root user: ml-user
RUN adduser -D ml-user
RUN adduser -D ml-user
USER ml-user
# Copy builder artefact
Expand Down Expand Up @@ -92,7 +92,7 @@ The following runtime standards are utilizes for Mojaloop.
# Create a non-root user: ml-user
RUN adduser -D ml-user
USER ml-user
# Copy builder artefact
COPY --chown=ml-user --from=builder /opt/app ./
Expand Down Expand Up @@ -173,7 +173,7 @@ window.alert('hi'); // ✗ avoid

### Typescript

> *Note: Standard and Typescript*
> *Note: Standard and Typescript*
>
> As we start to introduce more Typescript into the codebase, Standard becomes less useful, and can even be detrimental
> to our development workflow if we try to run standard across the Javascript compiled from Typescript.
Expand Down Expand Up @@ -207,7 +207,7 @@ modules:
```yaml
# BAD:
id: org.example.Foo
id: org.example.Foo
modules:
- name: foo
sources:
Expand All @@ -234,14 +234,14 @@ cat ../Dockerfile | wc -l

# GOOD:
DIR="$( cd "$( dirname "${BASH_SOURCE[0]}" )" && pwd )"
cat ${DIR}/../Dockerfile | wc -l
cat ${DIR}/../Dockerfile | wc -l
```

For other recommended bash conventions, refer to this blog post: [Best Practices for Writing Shell Scripts](https://kvz.io/bash-best-practices.html)

## Documentation

- Documentation should be written in Markdown format.
- Documentation should be written in Markdown format.
- Hand drawn diagrams should use an editable SVG format (example - architecture / component / block / state transition diagrams) exported from [diagrams.net](https://app.diagrams.net)
> NOTE: Please ensure that you have imbedded the editable diagram when exporting the SVG from [diagrams.net](https://app.diagrams.net)!
- Sequence diagrams should use PlantUML
Expand Down Expand Up @@ -277,7 +277,7 @@ The directory structure guide requires:
│  ├── integration # Integration tests, matching the directory structure in `./src`.
│  ├── functional # Functional tests, matching the directory structure in `./src`.
│  └── util # Generic testing scripts and NodeJS helpers.
└── config
└── config
└── default.json # Default config file.
```

Expand Down Expand Up @@ -568,7 +568,7 @@ In the Mojaloop OSS Community, we are prefer the following tools and frameworks:

- **Web Server:** [`HapiJS`](https://github.com/hapijs/hapi)
- **Web UI Framework:** [`ReactJS`](https://reactjs.org/)
- **Runtime Configuration:** [`rc`](https://www.npmjs.com/package/rc) (both from env variables and config files)
- **Runtime Configuration:** [`convict`](https://www.npmjs.com/package/convict), with [`rc`](https://www.npmjs.com/package/rc) for legacy. (both for env variables and config files)
- **Package Management:** `npm`
- **Logging:** [`@mojaloop/central-services-logger`](https://github.com/mojaloop/central-services-logger#readme) library, built on top of Winston
- **Containers and Orchestration:** [`docker`](https://www.docker.com/) and [`kubernetes`](https://kubernetes.io/)
Expand Down

0 comments on commit 068c33b

Please sign in to comment.