Skip to content

Commit

Permalink
docs: clarify repository best practices (#79)
Browse files Browse the repository at this point in the history
  • Loading branch information
hknutsen authored Dec 5, 2023
1 parent 3a857f7 commit 17bffc4
Showing 1 changed file with 15 additions and 12 deletions.
27 changes: 15 additions & 12 deletions docs/best-practices.md
Original file line number Diff line number Diff line change
@@ -1,24 +1,27 @@
# Best practices

This document provides best practices for developing reusable Terraform modules in Equinor.

## Repository

- Use [this template](https://github.com/equinor/terraform-module-template) when creating your repository.

- The following accesses should be configured for the repository:
- Use the common naming convention `terraform-azurerm-<name>` when naming your repository.

| Team | Role |
| --- | --- |
| @equinor/terraform-baseline | `Write` |
| @equinor/terraform-baseline-admins | `Admin` |
For example, if you want to create a module named `storage`, the repository should be named `terraform-azurerm-storage`.

- The following code owners should be configured in a file `.github/CODEOWNERS`:
- Configure the following accesses for the repository:

```raw
* @equinor/terraform-baseline
```
| Team | Role |
| --- | --- |
| @equinor/terraform-baseline | `Write` |
| @equinor/terraform-baseline-admins | `Admin` |

## Naming convention
- Configure the following code owners in a file `.github/CODEOWNERS`:

- Use the common naming convention `terraform-azurerm-<name>` when naming your repository.
For example, if you want to create a module named `storage`, the repository should be named `terraform-azurerm-storage`.
```raw
* @equinor/terraform-baseline
```

## Roles and scope

Expand Down

0 comments on commit 17bffc4

Please sign in to comment.