From 6738c7d90c303a6f071eff93aff46fca3dd9f88d Mon Sep 17 00:00:00 2001 From: xavidop Date: Fri, 8 Nov 2024 10:53:29 +0100 Subject: [PATCH] feat: added community guidelines --- .github/CODEOWNERS | 1 + .github/FUNDING.yml | 15 ++++++++++++ .github/ISSUE_TEMPLATE/bug_report.md | 28 +++++++++++++++++++++++ .github/ISSUE_TEMPLATE/feature_request.md | 18 +++++++++++++++ .github/PULL_REQUEST_TEMPLATE.md | 20 ++++++++++++++++ .github/dependabot.yml | 15 ++++++++++++ CODE_OF_CONDUCT.md | 12 ++++++++++ CONTRIBUTING.md | 20 ++++++++++++++++ SECURITY.md | 9 ++++++++ 9 files changed, 138 insertions(+) create mode 100644 .github/CODEOWNERS create mode 100644 .github/FUNDING.yml create mode 100644 .github/ISSUE_TEMPLATE/bug_report.md create mode 100644 .github/ISSUE_TEMPLATE/feature_request.md create mode 100644 .github/PULL_REQUEST_TEMPLATE.md create mode 100644 .github/dependabot.yml create mode 100644 CODE_OF_CONDUCT.md create mode 100644 CONTRIBUTING.md create mode 100644 SECURITY.md diff --git a/.github/CODEOWNERS b/.github/CODEOWNERS new file mode 100644 index 0000000..a1fb2af --- /dev/null +++ b/.github/CODEOWNERS @@ -0,0 +1 @@ +* @xavidop \ No newline at end of file diff --git a/.github/FUNDING.yml b/.github/FUNDING.yml new file mode 100644 index 0000000..3ad724c --- /dev/null +++ b/.github/FUNDING.yml @@ -0,0 +1,15 @@ +# These are supported funding model platforms + +github: xavidop # Replace with up to 4 GitHub Sponsors-enabled usernames e.g., [user1, user2] +patreon: # Replace with a single Patreon username +open_collective: # Replace with a single Open Collective username +ko_fi: # Replace with a single Ko-fi username +tidelift: # Replace with a single Tidelift platform-name/package-name e.g., npm/babel +community_bridge: # Replace with a single Community Bridge project-name e.g., cloud-foundry +liberapay: # Replace with a single Liberapay username +issuehunt: # Replace with a single IssueHunt username +lfx_crowdfunding: # Replace with a single LFX Crowdfunding project-name e.g., cloud-foundry +polar: # Replace with a single Polar username +buy_me_a_coffee: # Replace with a single Buy Me a Coffee username +thanks_dev: # Replace with a single thanks.dev username +custom: # Replace with up to 4 custom sponsorship URLs e.g., ['link1', 'link2'] diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md new file mode 100644 index 0000000..2b7cb8b --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug_report.md @@ -0,0 +1,28 @@ +--- +name: Bug report +about: Create a bug report to help us improve +title: '' +labels: bug +--- + +**Describe the bug** +A clear and concise description of what the bug is. + +**To Reproduce** +Steps to reproduce the behavior: + +1. In step '...' +2. Provide the option '....' +3. See error + +**Expected behavior** +A clear and concise description of what you expected to happen. + +**Screenshots** +If applicable, add screenshots to help explain your problem. + +**Genkit version:** +Provide the Genkit version you are using. + +**Additional context** +Add any other context about the problem here. \ No newline at end of file diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md new file mode 100644 index 0000000..f7af49c --- /dev/null +++ b/.github/ISSUE_TEMPLATE/feature_request.md @@ -0,0 +1,18 @@ +--- +name: Feature request +about: Suggest an idea for this project +title: '' +labels: enhancement +--- + +**Is your feature request related to a problem? Please describe.** +A clear and concise description of what the problem is. Ex. I'm always frustrated when [...] + +**Describe the solution you'd like** +A clear and concise description of what you want to happen. + +**Describe alternatives you've considered** +A clear and concise description of any alternative solutions or features you've considered. + +**Additional context** +Add any other context or screenshots about the feature request here. \ No newline at end of file diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md new file mode 100644 index 0000000..636dbc9 --- /dev/null +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -0,0 +1,20 @@ +_Before you submit a pull request, please make sure you have read and understood the [contribution guidelines](https://github.com/xavidop/genkit-workshop/blob/main/CONTRIBUTING.md) and the [code of conduct](https://github.com/xavidop/genkit-workshop/blob/main/CODE_OF_CONDUCT.md)._ + +**This pull request is related to:** + +- [ ] A bug +- [ ] A new feature +- [ ] Documentation +- [ ] Other (please specify) + +**I have checked the following:** + +- [ ] I have read and understood the [contribution guidelines](https://github.com/xavidop/genkit-workshop/blob/main/CONTRIBUTING.md) and the [code of conduct](https://github.com/xavidop/genkit-workshop/blob/main/CODE_OF_CONDUCT.md); +- [ ] I have added new tests (for bug fixes/features); +- [ ] I have added/updated the documentation (for bug fixes / features). + +**Description:** +Please provide a clear and concise description of the changes you are proposing here. + +**Related issues:** +Please, link the related issues that this pull request will resolve here (if any). diff --git a/.github/dependabot.yml b/.github/dependabot.yml new file mode 100644 index 0000000..1c38df5 --- /dev/null +++ b/.github/dependabot.yml @@ -0,0 +1,15 @@ +# To get started with Dependabot version updates, you'll need to specify which +# package ecosystems to update and where the package manifests are located. +# Please see the documentation for more information: +# https://docs.github.com/github/administering-a-repository/configuration-options-for-dependency-updates +# https://containers.dev/guide/dependabot + +version: 2 +updates: + - package-ecosystem: "github-actions" + directory: "/" + labels: + - "github-actions" + - "dependencies" + schedule: + interval: daily diff --git a/CODE_OF_CONDUCT.md b/CODE_OF_CONDUCT.md new file mode 100644 index 0000000..5f4f99a --- /dev/null +++ b/CODE_OF_CONDUCT.md @@ -0,0 +1,12 @@ +# Code of Conduct + +We are committed to fostering a welcoming and inclusive community. By participating in this project, you agree to abide by our Code of Conduct: + +1. Be respectful and considerate of others. +2. Avoid discriminatory, harassing, or offensive behavior and speech. +3. Be open to constructive feedback and collaboration. +4. Respect the privacy and personal boundaries of others. + +If you experience or witness any violations of the Code of Conduct, please report them to the maintainers immediately. + +Thank you for helping us create a positive and productive environment for everyone! \ No newline at end of file diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..c3d666d --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,20 @@ +# Contributing + +This repos uses `claat` to generate the codelab pages. To contribute, you need to have `claat` installed in your machine. You can install it by running: + +```bash +go get -u github.com/googlecodelabs/tools/claat +``` + +After installing `claat`, you can run the following command to generate the codelab pages: + +```bash +claat export content/*.md +``` + +We welcome contributions to the Genkit Workshop! To contribute, please follow these steps: + +1. Fork the repository. +2. Create a new branch for your feature or bugfix. +3. Make your changes. +4. Submit a pull request with a detailed description of your changes. diff --git a/SECURITY.md b/SECURITY.md new file mode 100644 index 0000000..0c9dd64 --- /dev/null +++ b/SECURITY.md @@ -0,0 +1,9 @@ +# Security Policy + +## Supported Versions + +Only the last stable version at any given point. + +## Reporting a Vulnerability + +Vulnerabilities can be disclosed via email to xavierportillaedo@gmail.com