diff --git a/.github/ISSUE_TEMPLATE/bug-report.yml b/.github/ISSUE_TEMPLATE/bug-report.yml new file mode 100644 index 00000000..4675445e --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug-report.yml @@ -0,0 +1,47 @@ +name: "\U0001F41E Bug report" +description: Create a report to help us improve this project +# labels: ["pending triage"] +body: + - type: markdown + attributes: + # Please carefully read the contribution docs before creating a bug report + # 👉 https://v3.nuxtjs.org/community/reporting-bugs + value: | + Please use the template below to create a minimal reproduction + 👉 https://stackblitz.com/github/dargmuesli/nuxt-cookie-control?file=playground%2Fapp.vue + - type: textarea + id: bug-env + attributes: + label: Environment + description: You can use `npx nuxi info` to fill this section + placeholder: Environment + validations: + required: true + - type: textarea + id: reproduction + attributes: + label: Reproduction + description: Please provide a link to a repo that can reproduce the problem you ran into. A [**minimal reproduction**](https://stackblitz.com/github/dargmuesli/nuxt-cookie-control?file=playground%2Fapp.vue) is required unless you are absolutely sure that the issue is obvious and the provided information is enough to understand the problem. If a report is vague (e.g. just a generic error message) and has no reproduction, it will receive a "need reproduction" label. If no reproduction is provided we might close it. + placeholder: Reproduction + validations: + required: true + - type: textarea + id: bug-description + attributes: + label: Describe the bug + description: A clear and concise description of what the bug is. If you intend to submit a PR for this issue, tell us in the description. Thanks! + placeholder: Bug description + validations: + required: true + - type: textarea + id: additonal + attributes: + label: Additional context + description: If applicable, add any other context about the problem here + - type: textarea + id: logs + attributes: + label: Logs + description: | + Optional if provided reproduction. Please try not to insert an image but copy paste the log text. + render: shell diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml new file mode 100644 index 00000000..2f66bbcb --- /dev/null +++ b/.github/ISSUE_TEMPLATE/config.yml @@ -0,0 +1,10 @@ +contact_links: + - name: 💬 Discussions + url: https://github.com/dargmuesli/nuxt-cookie-control/discussions + about: Use discussions for asking questions + - name: 📚 README + url: https://github.com/dargmuesli/nuxt-cookie-control/blob/master/README.md + about: Check documentation on usage + - name: 📰 CHANGELOG + url: https://github.com/dargmuesli/nuxt-cookie-control/blob/master/CHANGELOG.md + about: Information on potentially breaking changes and migration instructions diff --git a/.github/ISSUE_TEMPLATE/feature-request.yml b/.github/ISSUE_TEMPLATE/feature-request.yml new file mode 100644 index 00000000..196d2dba --- /dev/null +++ b/.github/ISSUE_TEMPLATE/feature-request.yml @@ -0,0 +1,37 @@ +name: "🚀 Feature request" +description: Suggest a feature that will improve this project +# labels: ["pending triage"] +body: + - type: markdown + attributes: + value: | + Thank you for taking the time to fill out this feature request! +# +# Please carefully read the contribution docs before suggesting a new feature +# 👉 https://v3.nuxtjs.org/community/contribution/#creating-an-issue + - type: textarea + id: feature-description + attributes: + label: Describe the feature + description: A clear and concise description of what you think would be a helpful addition to this project, including the possible use cases and alternatives you have considered. If you have a working prototype or module that implements it, please include a link. + placeholder: Feature description + validations: + required: true + - type: checkboxes + id: additional-info + attributes: + label: Additional information + description: Additional information that helps us decide how to proceed. + options: + - label: Would you be willing to help implement this feature? + # - label: Could this feature be implemented as a module? + - type: checkboxes + id: required-info + attributes: + label: Final checks + description: Before submitting, please make sure you do the following + options: + # - label: Read the [contribution guide](https://v3.nuxtjs.org/community/contribution). + # required: true + - label: Check existing [discussions](https://github.com/nuxt/framework/discussions) and [issues](https://github.com/nuxt/framework/issues). + required: true diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 00000000..890c86e1 --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,35 @@ +# Contributing to @dargmuesli/nuxt-cookie-control + +## Your Questions +Please consider asking questions in [Discussions](https://github.com/dargmuesli/nuxt-cookie-control/discussions) or help networks like [StackOverflow](https://stackoverflow.com/questions/tagged/spotify-web-api-java) using the label `@dargmuesli/nuxt-cookie-control`. +Posting your question there will result in quick and helpful answers. + +Issues should only be used to file bug reports and ask questions that are targeted specifically at **this** project's source code. + +## Information Quality +Every constructive contribution is highly appreciated. +They help to keep this project up-to-date and running, especially because currently only voluntary maintainers and contributors take care of this repository. + +At the same time it is strongly recommended to follow certain guidelines when making contributions to open source projects like this one. +They ensure fast processing times and stable releases. + +Before changing anything in the code base, make sure to look into [the project's README](https://github.com/dargmuesli/nuxt-cookie-control/blob/master/README.md) and its [CHANGELOG](https://github.com/dargmuesli/nuxt-cookie-control/blob/master/CHANGELOG.md). +This project's code follows simple and consistent code conventions, which should be easy to grasp. +If not: always try to build the project on your machine first to catch mistakes! +It saves your time to be in the clear about those conventions as it significantly lowers the probability to receive change requests from maintainers and thereby the time until merge. + +Issues that do not provide enough information, that are unclear or not understandable will be closed until more qualitative information is provided. + +## Contribution Completeness +A contribution has to be *complete* to get accepted. +If you cannot complete the requirements, you're welcome to ask for help. +But bear in mind that this can take some time. + +A complete contribution implements a feature or a bug fix and keeps all [automated checks](https://github.com/dargmuesli/nuxt-cookie-control/actions) green! They should stay green as long as you can build the project on your machine. + +## Contribution Flow +1. Create a fork from this repository +1. Create a branch in your fork in which you develop your contribution (one branch per feature/fix) +1. Make sure your contribution follows the contribution guidelines above +1. Create meaningful and well-separated commits +1. Create a pull request from your feature branch to the correct branch of this project