open source requirements (#1)

* chore(docs): add support.md

* chore(docs): add contributing.md

* chore(docs): include terraform fmt in contributing.md

* style: terraform fmt

* chore(docs): add link to terraform style guide

* fix(docs): update repo paths and references

* chore(codespaces): add devcontainer config

* style: terraform fmt autofixes

Author: garnertb

.devcontainer/devcontainer.json

@@ -0,0 +1,6 @@
+{
+  "image": "mcr.microsoft.com/devcontainers/universal:2",
+  "features": {
+    "ghcr.io/devcontainers/features/terraform:1": {}
+  }
+}

CONTRIBUTING.md

@@ -0,0 +1,33 @@
+# Contributing
+
+[fork]: https://github.com/github/terraform-github-runner-vnet/fork
+[pr]: https://github.com/github/terraform-github-runner-vnet/compare
+
+Hi there! We're thrilled that you'd like to contribute to this project. Your help is essential for keeping it great.
+
+Contributions to this project are [released](https://help.github.com/articles/github-terms-of-service/#6-contributions-under-repository-license) to the public under the [project's open source license](LICENSE).
+
+Please note that this project is released with a [Contributor Code of Conduct](CODE_OF_CONDUCT.md). By participating in this project you agree to abide by its terms.
+
+## Submitting a pull request
+
+1. [Fork][fork] and clone the repository
+1. Configure and install the dependencies: `terraform init`
+1. Create a new branch: `git checkout -b my-branch-name`
+1. Make your change, validate and confirm it works.
+1. Format your code with `terraform fmt`.
+1. Push to your fork and [submit a pull request][pr]
+1. Pat yourself on the back and wait for your pull request to be reviewed and merged.
+
+Here are a few things you can do that will increase the likelihood of your pull request being accepted:
+
+- Follow the [terraform styling conventions](https://developer.hashicorp.com/terraform/language/style#code-formatting) in the repository and run `terraform fmt` on your code before committing.
+- Validate your changes with `terraform validate`, `terraform plan` and `terraform apply`.
+- Keep your change as focused as possible. If there are multiple changes you would like to make that are not dependent upon each other, consider submitting them as separate pull requests.
+- Write a [good commit message](http://tbaggery.com/2008/04/19/a-note-about-git-commit-messages.html).
+
+## Resources
+
+- [How to Contribute to Open Source](https://opensource.guide/how-to-contribute/)
+- [Using Pull Requests](https://help.github.com/articles/about-pull-requests/)
+- [GitHub Help](https://help.github.com)

README.md

@@ -10,22 +10,22 @@ Terraform modules that configure and maintain the infrastructure needed to run G
 
 This repo contains two Terraform modules:
 
-* [nsg](./modules/nsg/) module: Uses a [Network Security Group (NSG)](https://learn.microsoft.com/en-us/azure/virtual-network/network-security-groups-overview) to manage the network security of the VNet.
+- [nsg](./modules/nsg/) module: Uses a [Network Security Group (NSG)](https://learn.microsoft.com/en-us/azure/virtual-network/network-security-groups-overview) to manage the network security of the VNet.
 
 ```hcl
 module "github_runner_vnet" {
   # Use the nsg version
-  source = "github.com/garnertb/github-runner-vnet/nsg"
+  source = "github.com/github/terraform-github-runner-vnet/nsg"
 
   # The resources use this base_name as a name prefix, e.g. ${base_name}-rg for the resource group
   base_name = "vnet-test"
-  
+
   # Retrieve through the GitHub API (see GitHub docs for instructions)
   github_enterprise_id = "12345"
 }
 ```
 
-* [firewall](./modules/firewall/) module: Uses an [Azure Firewall](https://learn.microsoft.com/en-us/azure/firewall/overview) to manage the network security of the VNet.
+- [firewall](./modules/firewall/) module: Uses an [Azure Firewall](https://learn.microsoft.com/en-us/azure/firewall/overview) to manage the network security of the VNet.
 
 <details><summary>Terraform config for the firewall</summary>
 
@@ -34,11 +34,11 @@ Provision and configure the infrastructure in Terraform by calling this module:
 ```hcl
 module "github_runner_vnet" {
   # Use the firewall version
-  source = "github.com/garnertb/github-runner-vnet/firewall"
+  source = "github.com/github/terraform-github-runner-vnet/firewall"
 
   # The resources use this base_name as a name prefix, e.g. ${base_name}-rg for the resource group
   base_name = "vnet-test"
-  
+
   # Retrieve through the GitHub API (see GitHub docs for instructions)
   github_enterprise_id = "12345"
 }

SUPPORT.md

@@ -0,0 +1,13 @@
+# Support
+
+## How to file issues and get help
+
+This project uses GitHub issues to track bugs and feature requests. Please search the existing issues before filing new issues to avoid duplicates. For new issues, file your bug or feature request as a new issue.
+
+For help or questions about using this project, please open an issue.
+
+- `terraform-github-runner-vnet` is not actively developed but is maintained by GitHub staff **AND THE COMMUNITY**. We will do our best to respond to support and community questions in a timely manner.
+
+## GitHub Support Policy
+
+Support for this project is limited to the resources listed above.

examples/example-firewall/main.tf

@@ -1,7 +1,6 @@
 # Create a VNET using an Azure Firewall to control the VNET network access
 module "vnet" {
-  source = "github.com/garnertb/github-runner-vnet//modules/firewall"
-
+  source             = "github.com/github/terraform-github-runner-vnet//modules/firewall"
   base_name          = var.base_name
   github_business_id = var.github_business_id
 }

examples/example-nsg/main.tf

@@ -1,7 +1,6 @@
 # Create a VNET using an Azure Network Security Group to control the VNET network access
 module "vnet" {
-  source = "github.com/garnertb/github-runner-vnet//modules/nsg"
-
+  source             = "github.com/github/terraform-github-runner-vnet//modules/nsg"
   base_name          = var.base_name
   github_business_id = var.github_business_id
 }