Skip to content

Commit

Permalink
added PR and issue templates (#160)
Browse files Browse the repository at this point in the history
  • Loading branch information
ananyaarun authored and jywarren committed Apr 9, 2019
1 parent c8f60f7 commit cb4b728
Show file tree
Hide file tree
Showing 5 changed files with 90 additions and 13 deletions.
28 changes: 28 additions & 0 deletions .github/ISSUE_TEMPLATE/ISSUE_TEMPLATE.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,28 @@
### Please describe the problem (or idea)

> What happened just before the problem occurred? Or what problem could this idea solve?


> What did you expect to see that you didn't?


### Please show us where to look

https://publiclab.org/ ... or https://publiclab.github.io/leaflet-environmental-layers/example

### Browser, version, and operating system

> Many bugs are related to these -- please help us track it down and reproduce what you're seeing!

****

## Thank you!

Your help makes Public Lab better! We *deeply* appreciate your helping refine and improve this site.

To learn how to write really great issues, which increases the chances they'll be resolved, see:

https://publiclab.org/wiki/developers#Contributing+for+non-coders
17 changes: 17 additions & 0 deletions .github/PULL_REQUEST_TEMPLATE.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
Fixes #0000 (<=== Add issue number here)

Make sure these boxes are checked before your pull request (PR) is ready to be reviewed and merged. Thanks!

* [ ] PR is descriptively titled 📑 and links the original issue above 🔗
* [ ] tests pass -- look for a green checkbox ✔️ a few minutes after opening your PR
* [ ] code is in uniquely-named feature branch and has no merge conflicts 📁
* [ ] screenshots/GIFs are attached 📎 in case of UI updation
* [ ] ask `@publiclab/reviewers` for help, in a comment below

> We're happy to help you get this ready -- don't be afraid to ask for help, and **don't be discouraged** if your tests fail at first!
If tests do fail, click on the red `X` to learn why by reading the logs.

Please be sure you've reviewed our contribution guidelines at https://publiclab.org/contributing-to-public-lab-software

Thanks!
32 changes: 23 additions & 9 deletions .github/config.yml
Original file line number Diff line number Diff line change
Expand Up @@ -4,22 +4,36 @@

# Comment to be posted to on first time issues
newIssueWelcomeComment: |
Thanks for opening your first issue here! Please follow the issue template to help us help you 👍🎉😄
If you have screenshots to share demonstrating the issue, that's really helpful! 📸 You can [make a gif](https://www.cockos.com/licecap/) too!
Thanks for opening your first issue! This space is [protected by our Code of Conduct](https://publiclab.org/conduct) - and we're here to help.
Please follow the issue template to help us help you 👍🎉😄
If you have screenshots [or a gif](https://publiclab.org/gifs/) to share demonstrating the issue, that's really helpful! 📸
Do join our [Gitter channel](https://gitter.im/publiclab/publiclab) for some brainstorming discussions.
# 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 opening this pull request! `Dangerbot` will test out your code and reply in a bit with some pointers and requests.
There may be some errors, **but don't worry!** We're here to help! 👍🎉😄
Thanks for opening this pull request! This space is [protected by our Code of Conduct](https://publiclab.org/conduct) - and we're here to help.
`Dangerbot` will test out your code and reply in a bit with some pointers and requests.
There may be some errors, **but don't worry!** We'll work through them with you! 👍🎉😄
It would be great if you can tell us your Twitter handle so we can thank you properly?
# 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: |
Congrats on merging your first pull request! 🙌🎉⚡️
Your code will likely be published to https://publiclab.github.io/leaflet-environmental-layers/example/ in the next few days.
In the meantime, can you tell us your Twitter handle so we can thank you properly?
Congrats on merging your first pull request! 🙌🎉⚡️
Your code will likely be published to https://publiclab.github.io/leaflet-environmental-layers/example/ in the next few days.
Do join our weekly check-in to share your this week goal and the awesome work you did 😃. Please find the link **pinned in the issue section** 📝
Now that you've completed this, you can help someone else take their first step!
See: [Public Lab's coding community!](https://code.publiclab.org)
Reach out to someone else working on theirs on [Public Lab's code welcome page](https://code.publiclab.org#r=all). Thanks!
<details>
<summary><b>Help others take their first step</b></summary>
<p>Now that you've merged your first pull request, you're the perfect person to help someone else out with this challenging first step. 🙌 </p>
<p><a href="https://code.publiclab.org#r=all">https://code.publiclab.org</a></p>
<p>Try looking at this list of `first-timers-only` issues, and see if someone else is waiting for feedback, or even stuck! 😕 </p>
<p>People often get stuck at the same steps, so you might be able to help someone get unstuck, or help lead them to some documentation that'd help. Reach out and be encouraging and friendly! 😄 🎉 </p>
<p>Read about <a href="https://github.com/publiclab/plots2/issues/3458">how to help support another newcomer here</a>, or find <a href="https://github.com/publiclab/plots2/labels/support">other ways to offer mutual support here</a>.</p>
</details>
# It is recommended to include as many gifs and emojis as possible
# It is recommend to include as many gifs and emojis as possible
14 changes: 10 additions & 4 deletions .github/first-timers-issue-template.md
Original file line number Diff line number Diff line change
Expand Up @@ -35,13 +35,19 @@ $DIFF

- [ ] 🏁 **Done** Ask in comments for a review :)

### Please keep us updated

### 🤔❓ Questions?
💬⏰ - We encourage contributors to be respectful to the community and provide an update **within a week** of claiming a first-timers-only issue. We're happy to keep it assigned to you as long as you need if you update us with a request for more time or help, but if we don't see any activity a week after you claim it we may reassign it to give someone else a chance. Thank you in advance!

Leave a comment below!
If this happens to you, don't sweat it! Grab another open issue.

### Is someone else already working on this?

We encourage you to link to this issue by mentioning the issue # in your pull request, so we can see if someone's already started on it. **If someone seem stuck, offer them some help!** Otherwise, [take a look at some other issues you can help with](https://publiclab.github.io/community-toolbox/#r=all). Thanks!
🔗- We encourage contributors to link to the original issue in their pull request so all users can easily see if someone's already started on it.

👥- **If someone seems stuck, offer them some help!** Otherwise, [take a look at some other issues you can help with](https://code.publiclab.org/#r=all). Thanks!

### 🤔❓ Questions?

Leave a comment below!

(This issue was created by [First-Timers-Bot](https://github.com/hoodiehq/first-timers-bot).)
12 changes: 12 additions & 0 deletions .github/first-timers.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
# You can change the labels to suit your needs if "first-timers-only" is not what you are looking for.
# These are some examples.
labels:
- first-timers-only
- help wanted

#If you would like to add your own template for the issue, add an .md file to your .github folder
template: .github/first-timers-issue-template.md

# You can create the issue in a different repo than where the problem is. Just make sure you installed the bot on the configured repository.
# The issue will link back to the original repository where the contribution will be made.
#repository: repo-name

0 comments on commit cb4b728

Please sign in to comment.