diff --git a/.github/ISSUE_TEMPLATE/bug_report.yml b/.github/ISSUE_TEMPLATE/bug_report.yml new file mode 100644 index 0000000..6453d63 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug_report.yml @@ -0,0 +1,56 @@ +name: Bug Report +description: File a bug/issue +title: "[BUG] " +labels: ["kind/bug", "needs-triage"] +body: + - type: checkboxes + attributes: + label: Is there an existing issue for this? + description: Please search to see if an issue already exists for the bug you encountered. + options: + - label: I have searched the existing issues + required: true + - type: textarea + attributes: + label: Kubernetes Version + description: The version of Kubernetes that you are using. + validations: + required: false + - type: textarea + attributes: + label: Shipwright Version + description: The version of Shipwright that you are using, can be a Release or a Commit SHA. + validations: + required: false + - type: textarea + attributes: + label: Current Behavior + description: A concise description of what you're experiencing. + validations: + required: false + - type: textarea + attributes: + label: Expected Behavior + description: A concise description of what you expected to happen. + validations: + required: false + - type: textarea + attributes: + label: Steps To Reproduce + description: Steps to reproduce the behavior. + placeholder: | + 1. In this environment... + 1. With this config... + 1. Run '...' + 1. See error... + validations: + required: false + - type: textarea + attributes: + label: Anything else? + description: | + Links? References? Anything that will give us more context about the issue you are encountering! + + Tip: You can attach images or log files by clicking this area to highlight it and then dragging files in. + validations: + required: false diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml new file mode 100644 index 0000000..f52b12f --- /dev/null +++ b/.github/ISSUE_TEMPLATE/config.yml @@ -0,0 +1,11 @@ +blank_issues_enabled: false +contact_links: + - name: Slack + url: https://kubernetes.slack.com/archives/C019ZRGUEJC + about: Participate in near real-time conversations with other Shipwright community members. Ask questions, get answers, build relationships. + - name: GitHub Discussions + url: https://github.com/shipwright-io/community/discussions + about: Join in-depth discussions about everything Shipwright, propose new features, debate to your hearts content, and help shape our future! + - name: Mailing Lists + url: https://lists.shipwright.io + about: Do you love your email client and want to spend more time using it? Then this is the place for you! Ask questions and get announcements all from the safety of your inbox. diff --git a/.github/ISSUE_TEMPLATE/feature_request.yml b/.github/ISSUE_TEMPLATE/feature_request.yml new file mode 100644 index 0000000..0ab5205 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/feature_request.yml @@ -0,0 +1,39 @@ +name: Feature Request +description: File a feature request +title: "[FEATURE] <title>" +labels: ["kind/feature", "needs-review"] +body: + - type: checkboxes + attributes: + label: Is there an existing feature request for this? + description: Please search to see if a request already exists for the feature that you are requesting. + options: + - label: I have searched the existing feature requests + required: true + - type: textarea + attributes: + label: Is your feature request related to a problem or use-case? Please describe. + description: A clear and concise description of what the problem or use-case is. Ex. I'm always frustrated when [...] + validations: + required: true + - type: textarea + attributes: + label: Describe the solution that you would like. + description: A clear and concise description of what you want to happen. + validations: + required: true + - type: textarea + attributes: + label: Describe alternatives you have considered. + description: A clear and concise description of any alternative solutions or features that you have considered. + validations: + required: false + - type: textarea + attributes: + label: Anything else? + description: | + Links? References? Anything that will give us more context about the feature that you are requesting. + + Tip: You can attach images or log files by clicking this area to highlight it and then dragging files in. + validations: + required: false diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md new file mode 100644 index 0000000..e460839 --- /dev/null +++ b/.github/pull_request_template.md @@ -0,0 +1,52 @@ +# Changes + +<!-- πŸŽ‰πŸŽ‰πŸŽ‰ Thank you for the PR!!! πŸŽ‰πŸŽ‰πŸŽ‰ --> + +<!-- Describe your changes here- ideally you can get that description straight from +your descriptive commit message(s)! --> + +<!-- If this PR fixes a GitHub issue, please mention it like so: + +Fixes #<insert issue number here> + +--> + +# Submitter Checklist + +- [ ] Includes tests if functionality changed/was added +- [ ] Includes docs if changes are user-facing +- [ ] [Set a kind label on this PR](https://prow.k8s.io/command-help#kind) +- [ ] Release notes block has been filled in, or marked NONE + +See [the contributor guide](https://github.com/shipwright-io/build/blob/main/CONTRIBUTING.md) +for details on coding conventions, github and prow interactions, and the code review process. + +# Release Notes + +<!-- +Describe any user facing changes here, or delete this block. + +Examples of user facing changes: +- API changes +- Bug fixes +- Any changes in behavior +- Changes requiring upgrade notices or deprecation warnings + +For pull requests with a release note: + +```release-note +Your release note here +``` + +For pull requests that require additional action from users switching to the new release, include the string "action required" (case insensitive) in the release note: + +```release-note +action required: your release note here +``` + +For pull requests that don't need to be mentioned at release time, use the `/release-note-none` Prow command to add the `release-note-none` label to the PR. You can also write the string "NONE" as a release note in your PR description: + +```release-note +NONE +``` +--> diff --git a/.github/workflows/issues.yml b/.github/workflows/issues.yml new file mode 100644 index 0000000..356b0cb --- /dev/null +++ b/.github/workflows/issues.yml @@ -0,0 +1,20 @@ +name: Add issue or pull request to Project + +on: + issues: + types: + - opened + pull_request_target: + types: + - opened + - reopened + +jobs: + add-to-project: + runs-on: ubuntu-latest + steps: + - name: Add issue to project + uses: actions/add-to-project@v0.5.0 + with: + project-url: https://github.com/orgs/shipwright-io/projects/6 + github-token: ${{ secrets.ADD_TO_PROJECT_TOKEN }} diff --git a/CODE_OF_CONDUCT.md b/CODE_OF_CONDUCT.md new file mode 100644 index 0000000..a33c6b6 --- /dev/null +++ b/CODE_OF_CONDUCT.md @@ -0,0 +1,133 @@ + +# Contributor Covenant Code of Conduct + +## Our Pledge + +We as members, contributors, and leaders pledge to make participation in our +community a harassment-free experience for everyone, regardless of age, body +size, visible or invisible disability, ethnicity, sex characteristics, gender +identity and expression, level of experience, education, socio-economic status, +nationality, personal appearance, race, caste, color, religion, or sexual +identity and orientation. + +We pledge to act and interact in ways that contribute to an open, welcoming, +diverse, inclusive, and healthy community. + +## Our Standards + +Examples of behavior that contributes to a positive environment for our +community include: + +* Demonstrating empathy and kindness toward other people +* Being respectful of differing opinions, viewpoints, and experiences +* Giving and gracefully accepting constructive feedback +* Accepting responsibility and apologizing to those affected by our mistakes, + and learning from the experience +* Focusing on what is best not just for us as individuals, but for the overall + community + +Examples of unacceptable behavior include: + +* The use of sexualized language or imagery, and sexual attention or advances of + any kind +* Trolling, insulting or derogatory comments, and personal or political attacks +* Public or private harassment +* Publishing others' private information, such as a physical or email address, + without their explicit permission +* Other conduct which could reasonably be considered inappropriate in a + professional setting + +## Enforcement Responsibilities + +Community leaders are responsible for clarifying and enforcing our standards of +acceptable behavior and will take appropriate and fair corrective action in +response to any behavior that they deem inappropriate, threatening, offensive, +or harmful. + +Community leaders 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, and will communicate reasons for moderation +decisions when appropriate. + +## Scope + +This Code of Conduct applies within all community spaces, and also applies when +an individual is officially representing the community in public spaces. +Examples of representing our community include using an official e-mail address, +posting via an official social media account, or acting as an appointed +representative at an online or offline event. + +## Enforcement + +Instances of abusive, harassing, or otherwise unacceptable behavior may be +reported to the community leaders responsible for enforcement at +[conduct@cd.foundation](mailto:conduct@cd.foundation). +All complaints will be reviewed and investigated promptly and fairly. + +All community leaders are obligated to respect the privacy and security of the +reporter of any incident. + +## Enforcement Guidelines + +Community leaders will follow these Community Impact Guidelines in determining +the consequences for any action they deem in violation of this Code of Conduct: + +### 1. Correction + +**Community Impact**: Use of inappropriate language or other behavior deemed +unprofessional or unwelcome in the community. + +**Consequence**: A private, written warning from community leaders, providing +clarity around the nature of the violation and an explanation of why the +behavior was inappropriate. A public apology may be requested. + +### 2. Warning + +**Community Impact**: A violation through a single incident or series of +actions. + +**Consequence**: A warning with consequences for continued behavior. No +interaction with the people involved, including unsolicited interaction with +those enforcing the Code of Conduct, for a specified period of time. This +includes avoiding interactions in community spaces as well as external channels +like social media. Violating these terms may lead to a temporary or permanent +ban. + +### 3. Temporary Ban + +**Community Impact**: A serious violation of community standards, including +sustained inappropriate behavior. + +**Consequence**: A temporary ban from any sort of interaction or public +communication with the community for a specified period of time. No public or +private interaction with the people involved, including unsolicited interaction +with those enforcing the Code of Conduct, is allowed during this period. +Violating these terms may lead to a permanent ban. + +### 4. Permanent Ban + +**Community Impact**: Demonstrating a pattern of violation of community +standards, including sustained inappropriate behavior, harassment of an +individual, or aggression toward or disparagement of classes of individuals. + +**Consequence**: A permanent ban from any sort of public interaction within the +community. + +## Attribution + +This Code of Conduct is adapted from the [Contributor Covenant][homepage], +version 2.1, available at +[https://www.contributor-covenant.org/version/2/1/code_of_conduct.html][v2.1]. + +Community Impact Guidelines were inspired by +[Mozilla's code of conduct enforcement ladder][Mozilla CoC]. + +For answers to common questions about this code of conduct, see the FAQ at +[https://www.contributor-covenant.org/faq][FAQ]. Translations are available at +[https://www.contributor-covenant.org/translations][translations]. + +[homepage]: https://www.contributor-covenant.org +[v2.1]: https://www.contributor-covenant.org/version/2/1/code_of_conduct.html +[Mozilla CoC]: https://github.com/mozilla/diversity +[FAQ]: https://www.contributor-covenant.org/faq +[translations]: https://www.contributor-covenant.org/translations diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..9025f3f --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,94 @@ +<!-- +Copyright The Shipwright Contributors + +SPDX-License-Identifier: Apache-2.0 +--> + +# Contributing Guidelines + +Welcome to Shipwright, we are glad you want to contribute to the project! +This document contains general guidelines for submitting contributions. +Each component of Shipwright will have its own specific guidelines. + +## Contributing prerequisites (CLA/DCO) + +The project does not yet define a Contributor License Agreement or +[Developer Certificate of Origin (DCO)](https://wiki.linuxfoundation.org/dco). +By submitting pull requests submitters acknowledge they grant the +[Apache License v2](./LICENSE) to the code and that they are eligible to grant this license for all commits submitted in their pull requests. + +## Getting Started + +All contributors must abide by our [Code of Conduct](/code-of-conduct.md). + +The core code for Shipwright is located in the following repositories: + +* [build](https://github.com/shipwright-io/build) - the Build APIs and associated controller to run builds. +* [cli](https://github.com/shipwright-io/cli) - the `shp` command line for Shipwright builds +* [operator](https://github.com/shipwright-io/operator) - an operator to install Shipwright components on Kubernetes via OLM. + +Technical documentation is spread across the code repositories, and is consolidated in the [website](https://github.com/shipwright-io/website) repository. +Content in `website` is published to [shipwright.io](https://shipwright.io) + +## Creating new Issues + +We recommend to open an issue for the following scenarios: + +- Asking for help or questions. (_Use the **discussion** or **help_wanted** label_) +- Reporting a bug. (_Use the **kind/bug** label_) +- Requesting a new feature. (_Use the **kind/feature** label_) + +Use the following checklist to determine where you should create an issue: + +- If the issue is related to how a Build or BuildRun behaves, or related to Build strategies, create an issue in [build](https://github.com/shipwright-io/build). +- If the issue is related to the command line, create an issue in [cli](https://github.com/shipwright-io/cli). +- If the issue is related to how the operator installs Shipwright on a cluster, create an issue in [operator](https://github.com/shipwright-io/operator). +- If the issue is related to the shipwright.io website, create an issue in [website](https://github.com/shipwright-io/website). + +If you are not sure, create an issue in this repository, and the Shipwright maintainers will route it to the correct location. + +If feature request is sufficiently broad or significant, the community may ask you to submit a SHIP enhancement proposal. +Please refer to the [SHIP guidelines](/ships/README.md) to learn how to submit a SHIP proposal. + +## Writing Pull Requests + +Contributions can be submitted by creating a pull request on Github. +We recommend you do the following to ensure the maintainers can collaborate on your contribution: + +- Fork the project into your personal Github account +- Create a new feature branch for your contribution +- Make your changes +- If you make code changes, ensure tests are passing +- Open a PR with a clear description, completing the pull request template if one is provided + Please reference the appropriate GitHub issue if your pull request provides a fix. + +## Code review process + +Once your pull request is submitted, a Shipwright maintainer should be assigned to review your changes. + +The code review should cover: + +- Ensure all related tests (unit, integration and e2e) are passing. +- Ensure the code style is compliant with the [coding conventions](https://github.com/kubernetes/community/blob/master/contributors/guide/coding-conventions.md) +- Ensure the code is properly documented, e.g. enough comments where needed. +- Ensure the code is adding the necessary test cases (unit, integration or e2e) if needed. + +Contributors are expected to respond to feedback from reviewers in a constructive manner. +Reviewers are expected to respond to new submissions in a timely fashion, with clear language if changes are requested. + +Once the pull request is approved and marked "lgtm", it will get merged. + +## Community Meetings Participation + +We run the community meetings every Monday at 13:00 UTC time. +For each upcoming meeting we generate a new issue where we layout the topics to discuss. +See our [previous meetings](https://github.com/shipwright-io/build/issues?q=is%3Aissue+label%3Acommunity+is%3Aclosed) outcomes. +Please request an invite in our Slack [channel](https://kubernetes.slack.com/archives/C019ZRGUEJC) or join the [shipwright-dev mailing list](https://lists.shipwright.io/admin/lists/shipwright-users.lists.shipwright.io/). + +All meetings are also published on our [public calendar](https://calendar.google.com/calendar/embed?src=shipwright-admin%40lists.shipwright.io&ctz=America%2FNew_York). + +## Contact Information + +- [Slack channel](https://kubernetes.slack.com/archives/C019ZRGUEJC) +- End-user email list: [shipwright-users@lists.shipwright.io](https://lists.shipwright.io/admin/lists/shipwright-users.lists.shipwright.io/) +- Developer email list: [shipwright-dev@lists.shipwright.io](https://lists.shipwright.io/admin/lists/shipwright-dev.lists.shipwright.io/) diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..261eeb9 --- /dev/null +++ b/LICENSE @@ -0,0 +1,201 @@ + Apache License + Version 2.0, January 2004 + http://www.apache.org/licenses/ + + TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION + + 1. Definitions. + + "License" shall mean the terms and conditions for use, reproduction, + and distribution as defined by Sections 1 through 9 of this document. + + "Licensor" shall mean the copyright owner or entity authorized by + the copyright owner that is granting the License. + + "Legal Entity" shall mean the union of the acting entity and all + other entities that control, are controlled by, or are under common + control with that entity. For the purposes of this definition, + "control" means (i) the power, direct or indirect, to cause the + direction or management of such entity, whether by contract or + otherwise, or (ii) ownership of fifty percent (50%) or more of the + outstanding shares, or (iii) beneficial ownership of such entity. + + "You" (or "Your") shall mean an individual or Legal Entity + exercising permissions granted by this License. + + "Source" form shall mean the preferred form for making modifications, + including but not limited to software source code, documentation + source, and configuration files. + + "Object" form shall mean any form resulting from mechanical + transformation or translation of a Source form, including but + not limited to compiled object code, generated documentation, + and conversions to other media types. + + "Work" shall mean the work of authorship, whether in Source or + Object form, made available under the License, as indicated by a + copyright notice that is included in or attached to the work + (an example is provided in the Appendix below). + + "Derivative Works" shall mean any work, whether in Source or Object + form, that is based on (or derived from) the Work and for which the + editorial revisions, annotations, elaborations, or other modifications + represent, as a whole, an original work of authorship. For the purposes + of this License, Derivative Works shall not include works that remain + separable from, or merely link (or bind by name) to the interfaces of, + the Work and Derivative Works thereof. + + "Contribution" shall mean any work of authorship, including + the original version of the Work and any modifications or additions + to that Work or Derivative Works thereof, that is intentionally + submitted to Licensor for inclusion in the Work by the copyright owner + or by an individual or Legal Entity authorized to submit on behalf of + the copyright owner. For the purposes of this definition, "submitted" + means any form of electronic, verbal, or written communication sent + to the Licensor or its representatives, including but not limited to + communication on electronic mailing lists, source code control systems, + and issue tracking systems that are managed by, or on behalf of, the + Licensor for the purpose of discussing and improving the Work, but + excluding communication that is conspicuously marked or otherwise + designated in writing by the copyright owner as "Not a Contribution." + + "Contributor" shall mean Licensor and any individual or Legal Entity + on behalf of whom a Contribution has been received by Licensor and + subsequently incorporated within the Work. + + 2. Grant of Copyright License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + copyright license to reproduce, prepare Derivative Works of, + publicly display, publicly perform, sublicense, and distribute the + Work and such Derivative Works in Source or Object form. + + 3. Grant of Patent License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + (except as stated in this section) patent license to make, have made, + use, offer to sell, sell, import, and otherwise transfer the Work, + where such license applies only to those patent claims licensable + by such Contributor that are necessarily infringed by their + Contribution(s) alone or by combination of their Contribution(s) + with the Work to which such Contribution(s) was submitted. If You + institute patent litigation against any entity (including a + cross-claim or counterclaim in a lawsuit) alleging that the Work + or a Contribution incorporated within the Work constitutes direct + or contributory patent infringement, then any patent licenses + granted to You under this License for that Work shall terminate + as of the date such litigation is filed. + + 4. Redistribution. You may reproduce and distribute copies of the + Work or Derivative Works thereof in any medium, with or without + modifications, and in Source or Object form, provided that You + meet the following conditions: + + (a) You must give any other recipients of the Work or + Derivative Works a copy of this License; and + + (b) You must cause any modified files to carry prominent notices + stating that You changed the files; and + + (c) You must retain, in the Source form of any Derivative Works + that You distribute, all copyright, patent, trademark, and + attribution notices from the Source form of the Work, + excluding those notices that do not pertain to any part of + the Derivative Works; and + + (d) If the Work includes a "NOTICE" text file as part of its + distribution, then any Derivative Works that You distribute must + include a readable copy of the attribution notices contained + within such NOTICE file, excluding those notices that do not + pertain to any part of the Derivative Works, in at least one + of the following places: within a NOTICE text file distributed + as part of the Derivative Works; within the Source form or + documentation, if provided along with the Derivative Works; or, + within a display generated by the Derivative Works, if and + wherever such third-party notices normally appear. The contents + of the NOTICE file are for informational purposes only and + do not modify the License. You may add Your own attribution + notices within Derivative Works that You distribute, alongside + or as an addendum to the NOTICE text from the Work, provided + that such additional attribution notices cannot be construed + as modifying the License. + + You may add Your own copyright statement to Your modifications and + may provide additional or different license terms and conditions + for use, reproduction, or distribution of Your modifications, or + for any such Derivative Works as a whole, provided Your use, + reproduction, and distribution of the Work otherwise complies with + the conditions stated in this License. + + 5. Submission of Contributions. Unless You explicitly state otherwise, + any Contribution intentionally submitted for inclusion in the Work + by You to the Licensor shall be under the terms and conditions of + this License, without any additional terms or conditions. + Notwithstanding the above, nothing herein shall supersede or modify + the terms of any separate license agreement you may have executed + with Licensor regarding such Contributions. + + 6. Trademarks. This License does not grant permission to use the trade + names, trademarks, service marks, or product names of the Licensor, + except as required for reasonable and customary use in describing the + origin of the Work and reproducing the content of the NOTICE file. + + 7. Disclaimer of Warranty. Unless required by applicable law or + agreed to in writing, Licensor provides the Work (and each + Contributor provides its Contributions) on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or + implied, including, without limitation, any warranties or conditions + of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A + PARTICULAR PURPOSE. You are solely responsible for determining the + appropriateness of using or redistributing the Work and assume any + risks associated with Your exercise of permissions under this License. + + 8. Limitation of Liability. In no event and under no legal theory, + whether in tort (including negligence), contract, or otherwise, + unless required by applicable law (such as deliberate and grossly + negligent acts) or agreed to in writing, shall any Contributor be + liable to You for damages, including any direct, indirect, special, + incidental, or consequential damages of any character arising as a + result of this License or out of the use or inability to use the + Work (including but not limited to damages for loss of goodwill, + work stoppage, computer failure or malfunction, or any and all + other commercial damages or losses), even if such Contributor + has been advised of the possibility of such damages. + + 9. Accepting Warranty or Additional Liability. While redistributing + the Work or Derivative Works thereof, You may choose to offer, + and charge a fee for, acceptance of support, warranty, indemnity, + or other liability obligations and/or rights consistent with this + License. However, in accepting such obligations, You may act only + on Your own behalf and on Your sole responsibility, not on behalf + of any other Contributor, and only if You agree to indemnify, + defend, and hold each Contributor harmless for any liability + incurred by, or claims asserted against, such Contributor by reason + of your accepting any such warranty or additional liability. + + END OF TERMS AND CONDITIONS + + APPENDIX: How to apply the Apache License to your work. + + To apply the Apache License to your work, attach the following + boilerplate notice, with the fields enclosed by brackets "[]" + replaced with your own identifying information. (Don't include + the brackets!) The text should be enclosed in the appropriate + comment syntax for the file format. We also recommend that a + file or class name and description of purpose be included on the + same "printed page" as the copyright notice for easier + identification within third-party archives. + + Copyright [yyyy] [name of copyright owner] + + Licensed under the Apache License, Version 2.0 (the "License"); + you may not use this file except in compliance with the License. + You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. diff --git a/README.md b/README.md index a46ae92..d5a7040 100644 --- a/README.md +++ b/README.md @@ -1 +1,2 @@ -# .github \ No newline at end of file +This repo contains the GitHub issue & pull request templates for the +[@shipwright-io](https://github.com/shipwright-io) project. diff --git a/SECURITY.md b/SECURITY.md new file mode 100644 index 0000000..bcdab22 --- /dev/null +++ b/SECURITY.md @@ -0,0 +1,13 @@ +# Shipwright Security and Disclosure Information + +Shipwright encourages all users and contributors to report potential security vulnerabilities to the project maintainers. +If you think you have found a security flaw related to Shipwright's code, please send a report using one of the below methods. + +### Report using GitHub issues + +To report a vulnerability via GitHub issues, click on the `Issues` tab at the top of any repository and then click on the `New issue` button, then click on the `Report a vulnerability` button and fill out the form. + +### Report using email + +To report a vulnerability via email, send an email to shipwright-security@lists.shipwright.io. +Encryption using GPG is NOT required to make a disclosure. diff --git a/SUPPORT.md b/SUPPORT.md new file mode 100644 index 0000000..e03d48c --- /dev/null +++ b/SUPPORT.md @@ -0,0 +1,46 @@ +# Support + +This article explains where to get help with Shipwright projects. +Please read through the following guidelines. + +> πŸ‘‰ **Note**: before participating in our community, please read our +> [code of conduct](CODE_OF_CONDUCT.md). +> By interacting with this repository, organization, or community you agree to +> abide by its terms. + +## Slack + +Participate in near real-time conversations with other Shipwright community members. Ask questions, get answers, build relationships. + +[Join the Kubernetes Slack workspace if you haven't already](slack.kubernetes.io), then [join the #shipwright channel](https://kubernetes.slack.com/archives/C019ZRGUEJC). + +## GitHub Discussions + +Join in-depth discussions about Shipwright, propose new features, debate to your hearts content, and help shape our future! + +[Join the Discussion](https://github.com/shipwright-io/community/discussions) + +## Mailing List + +Do you love your email client and want to spend more time using it? Then this is the place for you! Ask questions and get announcements all from the safety of your inbox. + +[Join the Community](https://lists.shipwright.io) + +## Help us help you! +Spend time framing questions and add links and resources. +Spending the extra time up front can help save everyone time in the long run. + +Here are some tips: + +* [Talk to a duck](https://rubberduckdebugging.com)! +* Don’t fall for the [XY problem](https://meta.stackexchange.com/questions/66377/what-is-the-xy-problem/66378#66378) +* Search to find out if a similar question has been asked +* Try to define what you need help with: + * Is there something in particular you want to do? + * What problem are you encountering and what steps have you taken to try + and fix it? + * Is there a concept you don’t understand? +* Provide sample code, such as a [CodeSandbox](https://codesandbox.io) or video, if possible +* Screenshots can help, but if there’s important text such as code or error + messages in them, please also provide those as text +* The more time you put into asking your question, the better we can help you diff --git a/profile/README.md b/profile/README.md new file mode 100644 index 0000000..066e72e --- /dev/null +++ b/profile/README.md @@ -0,0 +1,17 @@ +A framework for building container images on Kubernetes + +## Projects + +A few of the most popular libraries: + +* [**build**](https://github.com/shipwright-io/build), A framework for building container images on Kubernetes +* [**operator**](https://github.com/shipwright-io/operator), An operator to install and configure Shipwright Builds on Kubernetes clusters +* [**triggers**](https://github.com/shipwright-io/triggers), Event-driven Shipwright Builds +* [**cli**](https://github.com/shipwright-io/cli), A CLI for building container images on Kubernetes +* [**community**](https://github.com/shipwright-io/community), Community documentation for Shipwright +* [**website**](https://github.com/shipwright-io/website), Source code for the shipwright.io website +* [**image**](https://github.com/shipwright-io/image), Shipwright Image APIs and Operators + +## Help + +Open an issue on the relevant project. For security issues, see [SECURITY.md](https://github.com/shipwright-io/.github/blob/master/SECURITY.md).