From 80173294fdef0c4137a22698827f9c35cd5c7d4b Mon Sep 17 00:00:00 2001 From: dkool Date: Thu, 29 Aug 2024 08:49:53 +0200 Subject: [PATCH] feat: update documentation --- .github/CODEOWNERS | 5 ++- .github/ISSUE_TEMPLATE/question.yml | 46 +++++++++++++++++++++ .github/dependabot.yml | 6 ++- .github/release-please.yml | 3 ++ .github/workflows/release.yml | 12 ------ CODE_OF_CONDUCT.md | 63 +++++++++++++++++++++++++++++ CONTRIBUTE.md => CONTRIBUTING.md | 0 README.md | 18 ++++++++- SECURITY.md | 9 +++++ 9 files changed, 147 insertions(+), 15 deletions(-) create mode 100644 .github/ISSUE_TEMPLATE/question.yml create mode 100644 .github/release-please.yml delete mode 100644 .github/workflows/release.yml create mode 100644 CODE_OF_CONDUCT.md rename CONTRIBUTE.md => CONTRIBUTING.md (100%) create mode 100644 SECURITY.md diff --git a/.github/CODEOWNERS b/.github/CODEOWNERS index 103d3ba..eda0fb9 100644 --- a/.github/CODEOWNERS +++ b/.github/CODEOWNERS @@ -1 +1,4 @@ -* @CloudNationHQ/SG-MDM-GitHub-Azure-Wam +* @CloudNationHQ/SG-MDM-GitHub-Azure-Wam +CODEOWNERS @CloudNationHQ/SG-MDM-GitHub-Azure-Wam-Release +CHANGELOG.md @CloudNationHQ/SG-MDM-GitHub-Azure-Wam-Release +release-please.yml @CloudNationHQ/SG-MDM-GitHub-Azure-Wam-Release diff --git a/.github/ISSUE_TEMPLATE/question.yml b/.github/ISSUE_TEMPLATE/question.yml new file mode 100644 index 0000000..d90b29a --- /dev/null +++ b/.github/ISSUE_TEMPLATE/question.yml @@ -0,0 +1,46 @@ +name: "Question" +description: Create a new ticket for a question +title: "[REQUEST] - " +labels: [ + "new module" +] +body: + - type: checkboxes + attributes: + label: Is there an existing question for this? + description: Please search to see if an issue already exists for the question you are submitting. + options: + - label: I have searched the existing issues here and read the documentation. + required: true + - type: checkboxes + attributes: + label: Is your question related to this specific module? + description: Please make sure your question is related to this specific module. + options: + - label: My question is specific to this module + required: true + - type: input + id: question + attributes: + label: Question + description: Please leave your question here. + placeholder: I have a question about.... + validations: + required: true + - type: textarea + id: context + attributes: + label: Additional (Terraform) context + description: Please provide additional context (if needed). + validations: + required: false + - type: textarea + id: references + attributes: + label: References + description: | + Information about referencing Github Issues: https://help.github.com/articles/basic-writing-and-formatting-syntax/#referencing-issues-and-pull-requests + + Are there any other GitHub issues (open or closed) or pull requests that should be linked here? Vendor blog posts or documentation? For example: + + * https://azure.microsoft.com/en-us/roadmap/virtual-network-service-endpoint-for-azure-cosmos-db/ diff --git a/.github/dependabot.yml b/.github/dependabot.yml index 00a737f..53eee83 100644 --- a/.github/dependabot.yml +++ b/.github/dependabot.yml @@ -4,13 +4,17 @@ # https://docs.github.com/github/administering-a-repository/configuration-options-for-dependency-updates version: 2 -updates: +updates: - package-ecosystem: "github-actions" directory: "/" schedule: interval: "weekly" + commit-message: + prefix: "feat(deps):" - package-ecosystem: "gomod" directory: "/tests" schedule: interval: "weekly" + commit-message: + prefix: "feat(deps):" diff --git a/.github/release-please.yml b/.github/release-please.yml new file mode 100644 index 0000000..8d1ef71 --- /dev/null +++ b/.github/release-please.yml @@ -0,0 +1,3 @@ +primaryBranch: main +handleGHRelease: true +releaseType: go diff --git a/.github/workflows/release.yml b/.github/workflows/release.yml deleted file mode 100644 index 509a73d..0000000 --- a/.github/workflows/release.yml +++ /dev/null @@ -1,12 +0,0 @@ -name: release-please - -on: - push: - branches: - - main - workflow_dispatch: - -jobs: - release_please: - name: release - uses: cloudnationhq/terraform-azure-workflows/.github/workflows/release.yml@main diff --git a/CODE_OF_CONDUCT.md b/CODE_OF_CONDUCT.md new file mode 100644 index 0000000..3f0484d --- /dev/null +++ b/CODE_OF_CONDUCT.md @@ -0,0 +1,63 @@ +# Contributor Covenant Code of Conduct + +## Our Pledge + +In the interest of fostering an open and welcoming environment, we as +contributors and maintainers pledge to make participation in our project and +our community a harassment-free experience for everyone. + +## Our Standards + +Examples of behavior that contributes to creating a positive environment +include: + +* Using welcoming and inclusive language +* Being respectful of differing viewpoints and experiences +* Gracefully accepting constructive criticism +* Focusing on what is best for the community +* Showing empathy towards other community members + +Examples of unacceptable behavior by participants include: + +* The use of sexualized language or imagery and unwelcome sexual attention or + advances +* Trolling, insulting/derogatory comments, and personal or political attacks +* Public or private harassment +* Publishing others' private information, such as a physical or electronic + address, without explicit permission +* Other conduct which could reasonably be considered inappropriate in a + professional setting + +## Our Responsibilities + +Project maintainers are responsible for clarifying the standards of acceptable +behavior and are expected to take appropriate and fair corrective action in +response to any instances of unacceptable behavior. + +Project maintainers have the right and responsibility to remove, edit, or +reject comments, commits, code, wiki edits, issues, and other contributions +that are not aligned to this Code of Conduct, or to ban temporarily or +permanently any contributor for other behaviors that they deem inappropriate, +threatening, offensive, or harmful. + +## Scope + +This Code of Conduct applies within all project spaces, and it also applies when +an individual is representing the project or its community in public spaces. +Examples of representing a project or community include using an official +project e-mail address, posting via an official social media account, or acting +as an appointed representative at an online or offline event. Representation of +a project may be further defined and clarified by project maintainers. + +## Enforcement + +Instances of abusive, harassing, or otherwise unacceptable behavior may be +reported by contacting the project team at info@cloudnation.nl. All +complaints will be reviewed and investigated and will result in a response that +is deemed necessary and appropriate to the circumstances. The project team is +obligated to maintain confidentiality with regard to the reporter of an incident. +Further details of specific enforcement policies may be posted separately. + +Project maintainers who do not follow or enforce the Code of Conduct in good +faith may face temporary or permanent repercussions as determined by other +members of the project's leadership. diff --git a/CONTRIBUTE.md b/CONTRIBUTING.md similarity index 100% rename from CONTRIBUTE.md rename to CONTRIBUTING.md diff --git a/README.md b/README.md index 987d855..b1883b0 100644 --- a/README.md +++ b/README.md @@ -12,6 +12,16 @@ A primary goal is to utilize keys and values in the object that correspond to th A last key goal is to separate logic from configuration in the module, thereby enhancing its scalability, ease of customization, and manageability. +## Non-Goals + +These modules are not intended to be complete, ready-to-use solutions; they are designed as components for creating your own patterns. + +They are not tailored for a single use case but are meant to be versatile and applicable to a range of scenarios. + +Security standardization is applied at the pattern level, while the modules include default values based on best practices but do not enforce specific security standards. + +End-to-end testing is not conducted on these modules, as they are individual components and do not undergo the extensive testing reserved for complete patterns or solutions. + ## Features - simplified virtual wan deployment across regions @@ -96,9 +106,15 @@ Full examples detailing all usages, along with integrations with dependency modu Module is maintained by [these awesome contributors](https://github.com/cloudnationhq/terraform-azure-vwan/graphs/contributors). +## Contributing + +We welcome contributions from the community! Whether it's reporting a bug, suggesting a new feature, or submitting a pull request, your input is highly valued. + +For more information, please see our contribution [guidelines](./CONTRIBUTING.md). + ## License -MIT Licensed. See [LICENSE](https://github.com/cloudnationhq/terraform-azure-vwan/blob/main/LICENSE) for full details. +MIT Licensed. See [LICENSE](./LICENSE) for full details. ## Reference diff --git a/SECURITY.md b/SECURITY.md new file mode 100644 index 0000000..fb07ec1 --- /dev/null +++ b/SECURITY.md @@ -0,0 +1,9 @@ +# Security Policy + +## Reporting a Vulnerability + +We value security for the project very highly. We encourage all users to report any vulnerabilities they discover to us. +If you find a security vulnerability in our wam project, please report it responsibly by sending an email to security@cloudnation.nl + +At this juncture, we don't have a bug bounty program. We are a small team trying to solve a big problem. We urge you to report any vulnerabilities responsibly +so that we can continue building a secure application for the entire community.