Skip to content

Commit

Permalink
ci: update contribution information (#8367)
Browse files Browse the repository at this point in the history
* ci: update contribution information

* Update CONTRIBUTING.md

Co-authored-by: Dominik Moritz <domoritz@gmail.com>

* fix: remove double dot

* chore: remove line from PR template

* ci: add first-interaction message

* chore: readd workflow dispatch

Co-authored-by: Dominik Moritz <domoritz@gmail.com>
  • Loading branch information
lsh and domoritz committed Aug 18, 2022
1 parent 57a6be4 commit 2a7f1b3
Show file tree
Hide file tree
Showing 5 changed files with 16 additions and 5 deletions.
1 change: 0 additions & 1 deletion .github/PULL_REQUEST_TEMPLATE.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,6 @@ Please:
- Use imperative mood and present tense.
- Mention relevant issues in the description (e.g., `Fixes #1` / `Fixes part of #1`).
- [ ] Lint and test (Run `yarn test`).
- [ ] If you send a pull request from a fork, make sure that GitHub actions run successfully. Make sure to add a [`GH_PAT` secret](https://docs.github.com/en/free-pro-team@latest/actions/reference/encrypted-secrets) for a [personal access token](https://docs.github.com/en/free-pro-team@latest/github/authenticating-to-github/creating-a-personal-access-token) with public repository permissions.
- [ ] Review your changes before sending the PR (to ensure code quality).
- For new features:
- [ ] Add new unit tests.
Expand Down
4 changes: 2 additions & 2 deletions .github/workflows/check-toc.yml
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@ name: Check

on:
workflow_dispatch:
pull_request:
push:
paths:
- 'site/**'
- 'scripts/**'
Expand All @@ -17,7 +17,7 @@ jobs:
- uses: actions/checkout@v3
with:
token: ${{ secrets.GH_PAT || github.token }}
ref: ${{ github.event.pull_request.head.ref }}
ref: ${{ github.ref }}

- name: Setup Node
uses: actions/setup-node@v3
Expand Down
4 changes: 2 additions & 2 deletions .github/workflows/check.yml
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@ name: Check

on:
workflow_dispatch:
pull_request:
push:

jobs:
check:
Expand All @@ -13,7 +13,7 @@ jobs:
- uses: actions/checkout@v3
with:
token: ${{ secrets.GH_PAT || github.token }}
ref: ${{ github.event.pull_request.head.ref }}
ref: ${{ github.ref }}

- name: Setup Node
uses: actions/setup-node@v3
Expand Down
10 changes: 10 additions & 0 deletions .github/workflows/first-interaction.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
name: 'First Interaction'

on:
pull_request:

steps:
- uses: actions/first-interaction@v1
with:
repo-token: ${{ secrets.GITHUB_TOKEN }}
pr-message: 'Welcome to Vega. Since this is your first contribution, please make sure to read the [contributing guide](https://github.com/vega/vega-lite/blob/next/CONTRIBUTING.md).'
2 changes: 2 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,8 @@

Welcome to the Vega community. Everyone is welcome to contribute. We value all forms of contributions including code reviews, patches, examples, community participation, tutorial, and blog posts. In this document, we outline the guidelines for contributing to the various aspects of the project.

If you send a pull request from a fork, make sure that GitHub actions run successfully. Make sure to add a [`GH_PAT` secret](https://docs.github.com/en/free-pro-team@latest/actions/reference/encrypted-secrets) for a [personal access token](https://docs.github.com/en/free-pro-team@latest/github/authenticating-to-github/creating-a-personal-access-token) with public repository permissions.

If you find a bug in the code or a mistake in the [documentation](https://vega.github.io/vega-lite/docs/) or want a new feature, you can help us by creating an issue to [our repository](https://github.com/vega/vega-lite), or even submit a pull request (PR).

- For small fixes, please feel free to submit a pull request. Don't worry about creating an issue first.
Expand Down

0 comments on commit 2a7f1b3

Please sign in to comment.