Populate README with scope and maintenance status (taiidani#49)

* Add maintenance status and scope to README * Add basic package documentation * Add a couple checks to the PR template
kingsoftgames · Jun 12, 2021 · 45c42ad · 45c42ad
1 parent 3eac3f7
commit 45c42ad
Show file tree

Hide file tree

Showing 3 changed files with 14 additions and 0 deletions.
diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md
@@ -8,6 +8,9 @@
 
 # Test Steps
 
+- [ ] Have you updated the `docs/` folder to match your change?
+- [ ] Have you exercised your change using the `examples/` docker compose setup?
+
 ```sh
 make testacc
 ```

diff --git a/README.md b/README.md
@@ -14,6 +14,12 @@ This is a community provider and is not supported by Hashicorp.
 
 This provider has been published to the Terraform Registry at https://registry.terraform.io/providers/taiidani/jenkins. Please visit the registry for documentation and installation instructions.
 
+## Contributors
+
+This repository is actively maintained as free time allows for me to work on it. I am accepting Issues and Pull Requests and if you are interested in helping as a maintainer I am open to the possibility. Please allow for 2-3 weeks of turnaround time on your contributions.
+
+The scope of the provider covers the entire (extendable) Jenkins API provided that the https://github.com/bndr/gojenkins client library supports it. I accept submissions for functionality outside of Jenkins Core but expect that the plugin(s) required are _clearly stated_ in the documentation. See [jenkins_credential_vault_approle](https://registry.terraform.io/providers/taiidani/jenkins/latest/docs/resources/credential_vault_approle) for an example of this. I can only support these extensions as much as my own ability to test them allows -- Your Mileage May Vary.
+
 ## Developing the Provider
 
 Working on this provider requires the following:

diff --git a/main.go b/main.go
@@ -1,3 +1,8 @@
+// Package main defines the Jenkins Terraform Provider entrypoint.
+//
+// This file and the folder structure within the `jenkins/` subfolder conform to the Terraform provider expectations and
+// best practices at https://www.terraform.io/docs/extend/. Please see the generated documentation at
+// https://registry.terraform.io/providers/taiidani/jenkins for how to use the provider within Terraform itself.
 package main
 
 import (