Skip to content

Commit

Permalink
Add welcome bot and other first-time stuff (#1809)
Browse files Browse the repository at this point in the history
* Add welcome bot

* Update link to image

* Add reference to first-contributions repository
Add welcome bot to Docs Admins
  • Loading branch information
stevepiercy authored Dec 7, 2024
1 parent 4be627f commit db815ad
Show file tree
Hide file tree
Showing 5 changed files with 52 additions and 0 deletions.
40 changes: 40 additions & 0 deletions .github/config.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,40 @@
# Configuration for welcome bot - https://github.com/behaviorbot/welcome

# Configuration for new-issue-welcome - https://github.com/behaviorbot/new-issue-welcome

# Comment to be posted to on first time issues
newIssueWelcomeComment: >
Thanks for opening your first issue here!
Your engagement is essential for open source projects, including Plone. :hugs:
<br>If you haven't done so already,
read [Plone's Code of Conduct](https://plone.org/foundation/about/materials/foundation-resolutions/code-of-conduct).
Also please follow the issue template, as it helps both you and other community members contribute more effectively.
<br>If your issue is a feature request, others may raise its prominence through
[feature voting](https://6.docs.plone.org/contributing/documentation/index.html#github-menu).
<br>Welcome to the Plone community! :tada:
# Configuration for new-pr-welcome - https://github.com/behaviorbot/new-pr-welcome

# Comment to be posted to on PRs from first time contributors in your repository
newPRWelcomeComment: >
Thanks for submitting your first pull request! You are awesome! :hugs:
<br>If you haven't done so already, read
[Plone's Code of Conduct](https://plone.org/foundation/about/materials/foundation-resolutions/code-of-conduct)
and [Contribute to documentation](https://6.docs.plone.org/contributing/documentation/index.html),
as this will greatly help the review process.
<br>Welcome to the EBP community! :tada:
# Configuration for first-pr-merge - https://github.com/behaviorbot/first-pr-merge

# Comment to be posted to on pull requests merged by a first time user
firstPRMergeComment: >
Congratulations on your first merged pull request in this project! :tada:
![Congratulations](https://raw.githubusercontent.com/plone/documentation/fda4eadee4b0b71c4bcd0da739847444f74d3fc5/.github/images/congratulations.jpg)
<br>Thank you for contributing, we are very proud of you! :heart:
Binary file added .github/images/congratulations.jpg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
7 changes: 7 additions & 0 deletions docs/contributing/documentation/admins.md
Original file line number Diff line number Diff line change
Expand Up @@ -272,3 +272,10 @@ Only members of the Plone Documentation Team should update git submodules from t
# finally push your changes
git push
```


## Welcome bot

[Welcome](https://github.com/apps/welcome) bot automatically makes comments in issues and pull requests when a person creates their first issue, pull request, or merged pull request.
It is configured as a GitHub app.
Its configuration file is located at {file}`.github/config.yml`.
3 changes: 3 additions & 0 deletions docs/contributing/documentation/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -78,6 +78,8 @@ We currently use the branches `plone/[email protected]`, `plone/plone.api@master
```


(contributing-documentation-github-menu-label)=

## GitHub menu

In the upper right of the documentation, you will see the GitHub Octocat icon.
Expand All @@ -88,6 +90,7 @@ In the upper right of the documentation, you will see the GitHub Octocat icon.

You can use this menu to quickly navigate to the `documentation` source repository or open an issue.
You can also browse open issues and pull requests to see what has already been reported, or work started on, to improve Plone Documentation.
You can also give a reaction of a thumbs up 👍 on an issue or pull request to express that it is valuable to work on.

```{tip}
Working on documentation or on issues labeled with either `33 needs: docs` or `41 lvl: easy` are the two best ways for first-timers to contribute.
Expand Down
2 changes: 2 additions & 0 deletions docs/contributing/first-time.md
Original file line number Diff line number Diff line change
Expand Up @@ -27,6 +27,8 @@ The Plone organization may delete comments, lock conversations, or block GitHub
If you are a student or learner of Plone, you probably are not a contributor.
See the next section, {ref}`expectations-of-first-time-contributors`, to determine whether you are in fact a contributor.

To learn how to use git and GitHub and make your first contribution to open source software, visit the amazing resource [`first-contributions`](https://github.com/firstcontributions/first-contributions).

For free support, training, guidance, or mentoring, you should work through some trainings, use the [Plone Community Forum](https://community.plone.org/), participate in an [event](https://plone.org/news-and-events/events), and **not use GitHub**.


Expand Down

0 comments on commit db815ad

Please sign in to comment.