diff --git a/.github/ISSUE_TEMPLATE/bug-report.md b/.github/ISSUE_TEMPLATE/bug-report.md deleted file mode 100644 index 3e8346e97..000000000 --- a/.github/ISSUE_TEMPLATE/bug-report.md +++ /dev/null @@ -1,16 +0,0 @@ ---- -name: 'Bug report' -about: 'Create a bug report to help us improve' -labels: 'bug' ---- - -Type here... - ---- - -Please follow these steps to make it more efficient to solve your issue: - -- [ ] Since Altair is a Python wrapper around the Vega-Lite visualization grammar, [most bugs should be reported directly to Vega-Lite](https://github.com/vega/vega-lite/issues). You can click the Action Button of your Altair chart and "Open in Vega Editor" to create a reproducible Vega-Lite example and see if you get the same error in the Vega Editor. -- [ ] Search for duplicate issues. -- [ ] Use the latest version of Altair. -- [ ] Describe how to reproduce the bug and include the full code and data to reproduce it, ideally using a sample data set from `vega_datasets`. diff --git a/.github/ISSUE_TEMPLATE/bug-report.yml b/.github/ISSUE_TEMPLATE/bug-report.yml new file mode 100644 index 000000000..a699ba502 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug-report.yml @@ -0,0 +1,34 @@ +name: Bug report +description: Report something that is broken +labels: ["bug"] +body: + - type: markdown + attributes: + value: | + Thanks for taking the time to fill out this bug report! + + Note that since Altair is a Python wrapper around the Vega-Lite visualization grammar, [most bugs should be reported directly to Vega-Lite](https://github.com/vega/vega-lite/issues). You can click the Action Button (`...`) of your Altair chart and "Open in Vega Editor" to see if you get the same error in the Vega Editor. + + If you can't reproduce the bug in the Vega Editor, then make sure you are using [the latest version of Altair](https://github.com/altair-viz/altair/releases) and search for duplicate issues before filling out the form below. + - type: textarea + id: what-happened + attributes: + label: What happened? + description: | + Describe what happened and how to reproduce the bug. + Include the full code and data to reproduce it. Use a simple toy data set, e.g. from `vega_datasets`. + validations: + required: true + - type: textarea + id: desired-behavior + attributes: + label: What would you like to happen instead? + description: Describe the expected/desired behavior. + - type: input + id: altair-version + attributes: + label: Which version of Altair are you using? + description: Use `alt.__version__` to find out + - type: markdown + attributes: + value: By submitting this issue, you agree to follow our [Code of Conduct](../../CODE_OF_CONDUCT.md). diff --git a/.github/ISSUE_TEMPLATE/feature-request.md b/.github/ISSUE_TEMPLATE/feature-request.md deleted file mode 100644 index 25bd1215e..000000000 --- a/.github/ISSUE_TEMPLATE/feature-request.md +++ /dev/null @@ -1,15 +0,0 @@ ---- -name: 'Feature request' -about: 'Suggest a new idea or feature' -labels: 'enhancement' ---- - -Type here... - ---- - -Please follow these steps to make it more efficient to respond to your feature request. - -- [ ] Since Altair is a Python wrapper around the Vega-Lite visualization grammar, [most feature requests should be reported directly to Vega-Lite](https://github.com/vega/vega-lite/issues). You can click the Action Button of your Altair chart and "Open in Vega Editor" to create a reproducible Vega-Lite example. -- [ ] Search for duplicate issues. -- [ ] Describe the feature's goal, motivating use cases, and its expected behavior. diff --git a/.github/ISSUE_TEMPLATE/feature-request.yml b/.github/ISSUE_TEMPLATE/feature-request.yml new file mode 100644 index 000000000..3210adadd --- /dev/null +++ b/.github/ISSUE_TEMPLATE/feature-request.yml @@ -0,0 +1,26 @@ +name: Feature request +description: Suggest an improvement +labels: ["enhancement"] +body: + - type: markdown + attributes: + value: | + Thanks for taking the time to suggest a new feature! + + Note that since Altair is a Python wrapper around the Vega-Lite visualization grammar, [most feature requests should be reported directly to Vega-Lite](https://github.com/vega/vega-lite/issues). You can click the Action Button (`...`) of your Altair chart and "Open in Vega Editor" to see the Vega-Lite chart specification. + + If you believe this feature is more relevant for Altair than Vega-Lite, then make sure to search for duplicate issues before filling out the form below. + - type: textarea + id: what-happened + attributes: + label: What is your suggestion? + description: Describe the feature's goal, motivating use cases, and its expected behavior. + validations: + required: true + - type: textarea + id: alternative-solutions + attributes: + label: Have you considered any alternative solutions? + - type: markdown + attributes: + value: By submitting this issue, you agree to follow our [Code of Conduct](../../CODE_OF_CONDUCT.md). diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md new file mode 100644 index 000000000..c7b2a77c8 --- /dev/null +++ b/.github/pull_request_template.md @@ -0,0 +1,11 @@ + + +Thanks for contributing to Altair! + +Please follow these guidelines when submitting your PR: + +- Describe the purpose of the changes in PR, so that it is easy to understand the implication of the suggested changes. + - Here is a [helpful article about writing effective PR descriptions](https://medium.com/@greenberg/writing-pull-requests-your-coworkers-might-enjoy-reading-9d0307e93da3). +- Include unit tests and documentation for new features +- Ensure that the title is a concise [semantic commit message](https://www.conventionalcommits.org/) (e.g. "feat: Add `embed_options` to charts"). + - Append `!` if the change is breaking (e.g. "fix!: Raise error when `embed_options` is `None`") diff --git a/.github/release.yml b/.github/release.yml new file mode 100644 index 000000000..b319eeb01 --- /dev/null +++ b/.github/release.yml @@ -0,0 +1,17 @@ +changelog: + categories: + - title: Enhancements + labels: + - enhancement + - title: Bug Fixes + labels: + - bug + - title: Maintainance + labels: + - maintainance + - title: Documentation + labels: + - documentation + - title: Other Changes + labels: + - "*" diff --git a/.github/workflows/check-pr.yml b/.github/workflows/check-pr.yml new file mode 100644 index 000000000..d54e17496 --- /dev/null +++ b/.github/workflows/check-pr.yml @@ -0,0 +1,20 @@ +name: "Lint PR" + +on: + pull_request_target: + types: + - opened + - edited + - synchronize + +permissions: + pull-requests: read + +jobs: + main: + name: Validate PR title + runs-on: ubuntu-latest + steps: + - uses: amannn/action-semantic-pull-request@v5 + env: + GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}