From 24835190e14ff00db2466f4f3a4138addc1ff430 Mon Sep 17 00:00:00 2001 From: Matthew Anderson <42154938+matoszz@users.noreply.github.com> Date: Thu, 19 Sep 2024 11:17:52 -0600 Subject: [PATCH] minor updates --- .buildkite/pipeline.yaml | 1 - .github/CONTRIBUTING.md | 23 +++++++++++++++++++++++ .github/ISSUE_TEMPLATE/bug_report.md | 16 ++++++++++++++++ .github/ISSUE_TEMPLATE/feature_request.md | 14 ++++++++++++++ .pre-commit-config.yaml | 2 +- LICENSE | 2 +- README.md | 2 ++ 7 files changed, 57 insertions(+), 3 deletions(-) create mode 100644 .github/CONTRIBUTING.md create mode 100644 .github/ISSUE_TEMPLATE/bug_report.md create mode 100644 .github/ISSUE_TEMPLATE/feature_request.md diff --git a/.buildkite/pipeline.yaml b/.buildkite/pipeline.yaml index 948e407..2322c02 100644 --- a/.buildkite/pipeline.yaml +++ b/.buildkite/pipeline.yaml @@ -37,7 +37,6 @@ steps: image: "ghcr.io/theopenlane/build-image:latest" always-pull: true command: ["task", "go:lint"] - always-pull: true environment: - "GOTOOLCHAIN=auto" - label: ":golang: go test - libsql" diff --git a/.github/CONTRIBUTING.md b/.github/CONTRIBUTING.md new file mode 100644 index 0000000..5404b02 --- /dev/null +++ b/.github/CONTRIBUTING.md @@ -0,0 +1,23 @@ +# Contributing + +Please read the [contributing](.github/CONTRIBUTING.md) guide as well as the [Developer Certificate of Origin](https://developercertificate.org/). You will be required to sign all commits to the Openlane project, so if you're unfamiliar with how to set that up, see [github's documentation](https://docs.github.com/en/authentication/managing-commit-signature-verification/about-commit-signature-verification). + +Given external users will not have write to the branches in this repository, you'll need to follow the forking process to open a PR - [here](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/creating-a-pull-request-from-a-fork) is a guide from github on how to do so. + +## Licensing + +This repository contains open source software that comprises the Openlane stack which is open source software under [Apache 2.0](LICENSE). Openlane's SaaS / Cloud Services are products produced from this open source software exclusively by theopenlane, Inc. This product is produced under our published commercial terms (which are subject to change). Any logos or trademarks in our repositories in [theopenlane](https://github.com/theopenlane) organization are not covered under the Apache License and are trademarks of theopenlane, Inc. + +Others are allowed to make their own distribution of this software or include this software in other commercial offerings, but cannot use any of the Openlane logos, trademarks, cloud services, etc. + +## Security + +We take the security of our software products and services seriously, including our commercial services and all of the open source code repositories managed through our Github Organizations, such as [theopenlane](https://github.com/theopenlane). If you believe you have found a security vulnerability in any of our repositories or in our SaaS offering(s), please report it to us through coordinated disclosure. + +**Please do NOT report security vulnerabilities through public github issues, discussions, or pull requests!** + +Instead, please send an email to `security@theopenlane.io` with as much information as possible to best help us understand and resolve the issues. See the security policy attached to this repository for more details. + +## Questions? + +You can email us at `info@theopenlane.io`, open a github issue in this repository, or reach out to [matoszz](https://github.com/matoszz) directly. \ No newline at end of file diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md new file mode 100644 index 0000000..263ebe5 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug_report.md @@ -0,0 +1,16 @@ +--- +name: Bug report +about: Create a report to help us improve +title: "[Bug]" +labels: bug +assignees: '' + +--- + +**Describe the bug or issue you're encountering** + + +**What are the relevant steps to reproduce, including the version(s) of the relevant software?** + + +**What is the expected behavior?** diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md new file mode 100644 index 0000000..897f8f2 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/feature_request.md @@ -0,0 +1,14 @@ +--- +name: Feature request +about: Suggest an idea for this project +title: "[Feature Request]" +labels: enhancement +assignees: matoszz + +--- + +**Describe how the feature might make your life easier or solve a problem** + +**Describe the solution you'd like to see with any relevant context** + +**Describe any alternatives you've considered or if there are short-tern vs. long-term options** diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml index 58d6355..06858f6 100644 --- a/.pre-commit-config.yaml +++ b/.pre-commit-config.yaml @@ -12,6 +12,6 @@ repos: hooks: - id: yamlfmt - repo: https://github.com/crate-ci/typos - rev: v1.24.1 + rev: v1.24.6 hooks: - id: typos diff --git a/LICENSE b/LICENSE index a3d69de..1a8fa72 100644 --- a/LICENSE +++ b/LICENSE @@ -186,7 +186,7 @@ same "printed page" as the copyright notice for easier identification within third-party archives. - Copyright [2024] [The Open Lane, Inc.] + Copyright [2024] [theopenlane, Inc.] Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. diff --git a/README.md b/README.md index 1871eca..f2ce34b 100644 --- a/README.md +++ b/README.md @@ -12,4 +12,6 @@ Setup [Taskfile](https://taskfile.dev/installation/) by following the instructions and using one of the various convenient package managers or installation scripts. After installation, you can then simply run `task install` to load the associated dependencies. Nearly everything in this repository assumes you already have a local golang environment setup so this is not included. Please see the associated documentation. +## Contributing +See the [contributing](.github/CONTRIBUTING.md) guide for more information