Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: update documentation #319

Merged
merged 7 commits into from
Feb 22, 2024
Merged
Show file tree
Hide file tree
Changes from 3 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
File renamed without changes.
4 changes: 2 additions & 2 deletions CONTRIBUTING.md → .github/CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@ Following these guidelines helps to communicate that you respect the time of the

### Learn about our code of conduct

See the [code of conduct](CODE_OF_CONDUCT.md).
See the [code of conduct](./CODE_OF_CONDUCT.md).

### Got a Question or Problem?

Expand All @@ -49,7 +49,7 @@ If you find a bug in the source code or a mistake in the documentation, you can

### Found a security vulnerability?

If you discover a vulnerability in our software, please contact a [maintainer](.github/CODEOWNERS) directly and report it appropriately.
If you discover a vulnerability in our software, please contact a [maintainer](./CODEOWNERS) directly and report it appropriately.
Do not submit an issue, unless asked to.

### Missing a Feature?
Expand Down
9 changes: 9 additions & 0 deletions .github/PULL_REQUEST_TEMPLATE.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
# Description of changes

<!-- Fill in a description of what this PR changes/introduces/fixes -->

# Checklist

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

- [ ]
rjaegers marked this conversation as resolved.
Show resolved Hide resolved
File renamed without changes.
2 changes: 1 addition & 1 deletion .github/dependabot.yml
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ updates:
schedule:
interval: daily
groups:
minor-and-patch-action-updates:
github-actions:
update-types:
- minor
- patch
Expand Down
1 change: 0 additions & 1 deletion .mega-linter.yml
Original file line number Diff line number Diff line change
@@ -1,4 +1,3 @@
APPLY_FIXES: all
ENABLE:
- ACTION
- DOCKERFILE
Expand Down
10 changes: 5 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -81,27 +81,27 @@ The resulting containers can be used in a `.devcontainer.json` file or in a `.de

## Community

This project uses a [code of conduct](./CODE_OF_CONDUCT.md) to define expected conduct in our community. Instances of
abusive, harassing, or otherwise unacceptable behavior may be reported by contacting a project [CODEOWNER](./.github/CODEOWNERS)
This project uses a [code of conduct](.github/CODE_OF_CONDUCT.md) to define expected conduct in our community. Instances of
abusive, harassing, or otherwise unacceptable behavior may be reported to the repository administrators by using the [`Report content`](https://docs.github.com/en/communities/maintaining-your-safety-on-github/reporting-abuse-or-spam) functionality of GitHub.

## Changelog

See the [changelog](./CHANGELOG.md) for more info on what's been changed.

## Contributing

This project uses [Semantic Versioning 2.0.0](https://semver.org/spec/v2.0.0.html) and [Conventional Commits 1.0.0](https://www.conventionalcommits.org/en/v1.0.0/) please see the [contributing](./CONTRIBUTING.md) guideline for more information.
This project uses [Semantic Versioning 2.0.0](https://semver.org/spec/v2.0.0.html) and [Conventional Commits 1.0.0](https://www.conventionalcommits.org/en/v1.0.0/) please see the [contributing](.github/CONTRIBUTING.md) guideline for more information.

### Build & Test

The container can be built and tested locally by importing this repository in VS Code with the [`Remote Containers`](https://marketplace.visualstudio.com/items?itemName=ms-vscode-remote.remote-containers) plug-in installed. As a prerequisite Docker needs to be installed on the host system. Alternatively a GitHub Codespace can be started.

A test task is available to run the included `bats` tests. Choose `Tasks: Run Test Task` from the command pallette.
A test task is available to run the included `bats` tests. Choose `Tasks: Run Test Task` from the command pallette (<kbd>Ctrl</kbd> + <kbd>Shift</kbd> + <kbd>P</kbd>).

## Reporting vulnerabilities

If you find a vulnerability, please report it to us!
See [security](./SECURITY.md) for more information.
See [security](.github/SECURITY.md) for more information.

## Licenses

Expand Down