Skip to content

Commit

Permalink
Add contributing file (#9)
Browse files Browse the repository at this point in the history
Co-authored-by: Kasper Møller <[email protected]>
  • Loading branch information
housa and moller2866 authored Feb 18, 2025
1 parent b5f262e commit d1efa1e
Showing 1 changed file with 25 additions and 0 deletions.
25 changes: 25 additions & 0 deletions contributing.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
This guide is meant hold all of the experience from Eficodeans working with Kubernetes, distilled into one easily readable guide.

This means, that we welcome all contributions to 'what is the right tech stack'.

There are fundamentally 2 ways to contribute to this guide: recommend a tool, and adjust wording or tool areas of the guide.

## Recommend a tool

If you want to recommend a tool, the place to start is to write an Architecture Decision Record (ADR). All tools recommended in the guide is reflected in an ADR.

To add an ADR do the following:

`hugo new --kind adr <DesiredFolder>/ADRs/<NameOfADRFile>.md --source .pages`

Fill out the sections in the generated ADR

Create a PR with the ADR and let the discussion begin. If the PR is approved, the status should be updated to 'accepted', and the ADR previously in place should be updated to superseded by ADR-0123.

## Suggest more general edits to tool categories or text

Create a PR with your suggestions, it will automatically be assigned to the maintainers of the repo.

## Questions

If in doubt you can always reach out to the maintainers of this guide, maintainers can be found in the codeowners file in the .github folder.

0 comments on commit d1efa1e

Please sign in to comment.