Skip to content

Commit

Permalink
Merge pull request #518 from Ayush7614/master
Browse files Browse the repository at this point in the history
feat : added contributors and issue templates
  • Loading branch information
t-fine authored Mar 10, 2022
2 parents 3e5ff07 + 94dad76 commit a6efdde
Show file tree
Hide file tree
Showing 6 changed files with 139 additions and 0 deletions.
6 changes: 6 additions & 0 deletions .github/ISSUE_TEMPLATE/Other.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
---
name: Other
about: Something else

---

32 changes: 32 additions & 0 deletions .github/ISSUE_TEMPLATE/bug-report.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,32 @@
---
name: Bug report
about: Create a report to help us improve
title: ''
labels: bug
assignees: ''

---

**Describe the bug**
A clear and concise description of what the bug is.

**To Reproduce**
Steps to reproduce the behavior:
1. Go to '...'
2. Click on '....'
3. Scroll down to '....'
4. See error

**Expected behavior**
A clear and concise description of what you expected to happen.

**Screenshots**
If applicable, add screenshots to help explain your problem.

**Operating Environment:**
- Desktop, Cluster, Cloud, other
- OS, technology stack
- other

**Additional context**
Add any other context about the problem here.
30 changes: 30 additions & 0 deletions .github/ISSUE_TEMPLATE/documentation-update.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,30 @@
name: Documentation UpdateπŸ“„
description: Suggest how we can improve our documentation
title: "DocumentationπŸ“„: "
labels: [documentation]


body:
- type: markdown
attributes:
value: Thank you for taking the time to file a Documentation update report
- type: textarea
attributes:
label: What is the current documentation state?
description: "Copy and paste the text currently in the documentation. If you want to improve graphs or photos, please provide a screenshot of the original."
- type: textarea
attributes:
label: Where is this stated?
description: "Provide additional information about the location where you have copied the above statement from."
- type: textarea
attributes:
label: Why do you want to improve the statement?
description: "Please explain why the statement needs to be updated. This can be because it is confusing, incorrect, spelling/grammatical errors, etc."
- type: textarea
attributes:
label: Proposed Statement
description: "Please propose how you would rewrite the statement. If you have a precise proposal, please make the changes and open a pull request."
- type: textarea
attributes:
label: Additional context.
description: "Add any other context or useful information about the documentation update here."
25 changes: 25 additions & 0 deletions .github/ISSUE_TEMPLATE/feature_request.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
name: Feature Request
description: Suggest an idea for this project
title: "Feature Request: "
labels: [enhancement]

body:
- type: markdown
attributes:
value: Thank you for taking the time to file a Feature Request report.
- type: textarea
attributes:
label: Is your feature request related to a problem? Please describe.
description: 'A clear and concise description of what the problem is. Ex. I am always frustrated when [...]'
- type: textarea
attributes:
label: Describe the solution you'd like.
description: 'A clear and concise description of what you want to happen.'
- type: textarea
attributes:
label: Describe alternatives you've considered
description: 'A clear and concise description of any alternative solutions or features you have considered.'
- type: textarea
attributes:
label: Additional context.
description: 'Add any other context or screenshots about the feature request here.'
41 changes: 41 additions & 0 deletions .github/config.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,41 @@
# Configuration for welcome - 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: |
Hello there!πŸ‘‹ Welcome to Open-Horizon-Examples!πŸ’–
Thank you and congratulations πŸŽ‰ for opening your very first issue in this project.
Please checkout if any of the already existing issue template fits for your isssue or you may open a blank issue as well ✨
We will try to get back to you as soon as we can.πŸ‘€
# 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: |
Hello there!πŸ‘‹ Welcome to Open-Horizon-Examples!πŸ’–
Thank you and congrats πŸŽ‰ for opening your first PR on this project.✨
We will review it soon! Till then you can checkout the `README.md` for more details on it.
# 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 merging your first contribution to Open-Horizon-Examples!✨
# *Required* Comment to reply with
requestInfoReplyComment: >
Hi,
Thanks for raising an issue/pull request! We at Open-Horizon appreciate your concerns and views to
help us improve.
# *OPTIONAL* default titles to check against for lack of descriptiveness
# MUST BE ALL LOWERCASE
requestInfoDefaultTitles:
- update readme.md
- updates
- add files via upload
- readme.md
- changes made

# *OPTIONAL* Label to be added to Issues and Pull Requests with insufficient information given
requestInfoLabelToAdd: needs-more-info

# It is recommended to include as many gifs and emojis as possible!
5 changes: 5 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -52,3 +52,8 @@ Edge examples specific to the Watson IoT Platform are found in [edge/wiotp](edge
# Using Example Services
Each example service in this repo has a [README](edge/services/helloworld/README.md#horizon-hello-world-example-edge-service) that includes steps to run it when it is currently published in your exchange, or a ["Create your own"](edge/services/helloworld/CreateService.md#creating-your-own-hello-world-edge-service) set of instructions that will guide you through the process of publishing your own version to your exchange.

Contributors

<a href="https://github.com/open-horizon/examples/graphs/contributors">
<img src="https://contrib.rocks/image?repo=open-horizon/examples" />
</a>

0 comments on commit a6efdde

Please sign in to comment.