diff --git a/PULL_REQUEST_TEMPLATE.md b/PULL_REQUEST_TEMPLATE.md new file mode 100644 index 0000000..13e9359 --- /dev/null +++ b/PULL_REQUEST_TEMPLATE.md @@ -0,0 +1,39 @@ +Provide a general summary of your changes in the title above. You should +remove this overview, any sections and any section descriptions you +don't need below before submitting. There isn't a strict requirement to +use this template if you can structure your description and still cover +these points. + +## Description + +Describe your changes in detail through motivation and context. Why is +this change required? What problem does it solve? If it fixes an open +issue, link to the issue using GitHub's closing issues keywords[1]. + +## Has your change been tested? + +Explain how the change has been tested and what you ran to confirm your +change affects other parts of the code. Automated tests are generally +expected and changes without tests should explain why they aren't +required. + +## Screenshots (if appropriate): + +## Types of changes + +What sort of change does your code introduce/modify? + +- [ ] Bug fix (non-breaking change which fixes an issue) +- [ ] New feature (non-breaking change which adds functionality) +- [ ] Breaking change (fix or feature that would cause existing functionality to change) + +## Checklist: + +- [ ] My code follows the code style of this project. +- [ ] My change requires a change to the documentation. +- [ ] I have updated the documentation accordingly. +- [ ] I have added tests to cover my changes. +- [ ] All new and existing tests passed. +- [ ] This change is using publicly documented (api.cloudflare.com or developers.cloudflare.com) and stable APIs. + +[1]: https://help.github.com/articles/closing-issues-using-keywords/ diff --git a/changelog-check.yml b/changelog-check.yml new file mode 100644 index 0000000..45b8c40 --- /dev/null +++ b/changelog-check.yml @@ -0,0 +1,19 @@ +name: Changelog check +on: [pull_request_target] + +jobs: + changelog-check: + runs-on: ubuntu-latest + steps: + - uses: actions/checkout@v3 + - name: Set up Go + uses: actions/setup-go@v3 + with: + go-version-file: 'internal/tools/go.mod' + - run: go generate -tags tools internal/tools/tools.go + - run: go run cmd/changelog-check/main.go ${{ github.event.pull_request.number }} + working-directory: ./internal/tools + env: + GITHUB_OWNER: cloudflare + GITHUB_REPO: cloudflare-go + GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} diff --git a/feature_request.yml b/feature_request.yml new file mode 100644 index 0000000..75cbcd4 --- /dev/null +++ b/feature_request.yml @@ -0,0 +1,49 @@ +name: "\U0001F680 Feature request" +description: "Suggest a new feature or other enhancement" +labels: ["kind/enhancement", "needs-triage"] +body: +- type: input + attributes: + label: Current cloudflare-go version + description: | + If you're not using the latest version, please check to see if something related + to your request has already been implemented in a later version. + validations: + required: true +- type: textarea + attributes: + label: Description + description: Provide a quick (or expanded!) overview of the proposed change. + validations: + required: true +- type: textarea + attributes: + label: Use cases + description: | + In order to properly evaluate a feature request, it is necessary to understand + the use-cases for it. Please describe below the _end goal_ you are trying + to achieve that has led you to request this feature. + + Please keep this section focused on the problem and not on the suggested + solution. We'll get to that in a moment, below! + validations: + required: true +- type: textarea + attributes: + label: Potential cloudflare-go usage + description: | + Show how you think this should work and interact. No need to wrap the Go + code in backticks, it will be rendered as Go in the final output. + render: go + validations: + required: true + +- type: textarea + attributes: + label: References + description: | + Are there any other GitHub issues, whether open or closed, that are related to + the problem you've described above or to the suggested solution? If so, please + create a list below that mentions each of them. + validations: + required: false