Skip to content

Commit 9d3826f

Browse files
authored
Make contributing guidelines more visible (#250)
- Adds a `CONTRIBUTING.md` file (which simply links to the contributing guidelines in the docs) to improve visibility. The `CONTRIBUTING.md` file is shown on the main repo page. - Adds a first-interaction github workflow which also guides contributors to the guidelines in case they missed the guidelines before opening a PR. A comment with a link to the guidelines is posted on PRs from first-time contributors.
1 parent 771cce2 commit 9d3826f

File tree

2 files changed

+24
-0
lines changed

2 files changed

+24
-0
lines changed

.github/CONTRIBUTING.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
# Contributing
2+
3+
Please take some time to get familiar with the [contributing guidelines](https://docs.cscs.ch/contributing/) before making your first contribution.

.github/workflows/welcome.yaml

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
name: First interaction message
2+
3+
on:
4+
pull_request_target:
5+
types: [opened]
6+
branches:
7+
- main
8+
9+
jobs:
10+
greeting:
11+
runs-on: ubuntu-latest
12+
permissions:
13+
pull-requests: write
14+
steps:
15+
- uses: actions/first-interaction@v3
16+
with:
17+
pr-message: |
18+
Thank you for your contribution to eth-cscs/cscs-docs.
19+
20+
If you have not done so already, please take some time to get familiar with the [contributing guidelines](https://docs.cscs.ch/contributing/).
21+
Following the guidelines helps us keep the documentation consistent and as useful as possible for users.

0 commit comments

Comments
 (0)