Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion .github/CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -149,7 +149,7 @@ Before you submit your pull request consider the following guidelines:
1. Commit your changes using a descriptive commit message.

```shell
git commit --all
git commit -s -m 'Awesome commit message'
```

Note: the optional commit `-a` command-line option will automatically "add" and "rm" edited files.
Expand Down
6 changes: 3 additions & 3 deletions .github/PULL_REQUEST_TEMPLATE.md
Original file line number Diff line number Diff line change
@@ -1,16 +1,16 @@
# Pull Request
# :rocket: Hey, I have created a Pull Request

## Description of changes

<!-- Fill in a description of what this PR changes/introduces/fixes
Link to GitHub issues using keywords https://docs.github.com/en/get-started/writing-on-github/working-with-advanced-formatting/using-keywords-in-issues-and-pull-requests when necessary
-->

## Checklist
## :heavy_check_mark: Checklist

<!-- We follow conventional commit-style PR titles and kebab-case branch names -->

- [ ] I have followed the contribution guidelines for this repository
- [ ] I have followed the [contribution guidelines](https://github.com/philips-software/amp-devcontainer/blob/main/.github/CONTRIBUTING.md) for this repository
- [ ] I have added tests for new behavior, and have not broken any existing tests
- [ ] I have added or updated relevant documentation
- [ ] I have verified that all added components are accounted for in the SBOM
12 changes: 8 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,11 @@

## Overview

This repository contains [devcontainers](https://docs.github.com/en/codespaces/setting-up-your-project-for-codespaces/introduction-to-dev-containers) tailored towards modern, embedded, C++ and Rust development.
This repository contains [devcontainers](https://docs.github.com/en/codespaces/setting-up-your-project-for-codespaces/introduction-to-dev-containers) tailored towards modern, embedded, software development.

The containers try to be as ":battery: batteries included" as possible without being overly opinionated, and are useable for both local development and continuous integration.

All containers are multi-platform, and can be used on x64 (x86-64) and arm64 hardware on an operating system that supports an [OCI](https://opencontainers.org/) compatible container engine. This includes Windows and Linux, and macOS on both Intel and Apple silicon.

## State

Expand All @@ -16,7 +20,7 @@ This repository is under active development; see [pulse](https://github.com/phil

### Image variants

Two devcontainers are published towards the [GitHub Container Registry](https://ghcr.io/):
The following devcontainers are published towards the [GitHub Container Registry](https://ghcr.io/):

- [amp-devcontainer-cpp](https://github.com/orgs/philips-software/packages/container/package/amp-devcontainer-cpp); the C++ container
- [amp-devcontainer-rust](https://github.com/orgs/philips-software/packages/container/package/amp-devcontainer-rust); the Rust container
Expand All @@ -43,7 +47,7 @@ For embedded development and flashing and debugging [probe-rs](https://probe.rs/

### Visual Studio Code

Both containers can be used in Visual Studio Code or GitHub Codespaces without any additional configuration. All included tools are set-up and necessary plug-ins will be installed at container start. This behavior is implemented by appending devcontainer metadata to an image label according to the [specifications](https://containers.dev/implementors/reference/#labels). It is possible to override, amend or change the options following this [merge logic](https://containers.dev/implementors/spec/#merge-logic).
Both containers can be used in Visual Studio Code or GitHub Codespaces without any additional configuration. All included tools are set-up and necessary plug-ins will be installed at container start. This behavior is implemented by appending devcontainer metadata to an image label according to these [specifications](https://containers.dev/implementors/reference/#labels). It is possible to override, amend or change the options following this [merge logic](https://containers.dev/implementors/spec/#merge-logic).

## Usage

Expand Down Expand Up @@ -130,4 +134,4 @@ See [security](.github/SECURITY.md) for more information.

## Licenses

See [license](./LICENSE)
See [license](./LICENSE).
4 changes: 2 additions & 2 deletions test/cpp/features/static-dynamic-analysis.feature
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
Feature: Analyze source code using static and dynamic analysis

As a software craftsman
As a software craftsperson
To maintain consistent, high-quality and bug-free code
Source code needs to be statically and dynamically analyzed
I want my source code to be statically and dynamically analyzed

@fixme
Scenario: Format source code according to a formatting style
Expand Down
Loading