generated from camunda-community-hub/template-repo
-
Notifications
You must be signed in to change notification settings - Fork 1
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
0 parents
commit 7ab30b1
Showing
6 changed files
with
169 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,31 @@ | ||
#### Issue/Bug description | ||
|
||
|
||
|
||
#### Steps to reproduce the issue/bug | ||
|
||
1. | ||
2. | ||
3. | ||
|
||
|
||
#### What's the expected result, or what did you expect to happen? | ||
|
||
- | ||
|
||
|
||
#### What's the actual result? | ||
|
||
#### Platform details | ||
Where is this occurring? Please provide more details about your environment (computer/operating system setup). | ||
|
||
**Desktop (please complete the following information):** | ||
- OS: [e.g. OSX, Linux] | ||
- Browser [e.g. Chrome, Safari, Firefox] | ||
- Version [e.g. 22 or web app/IDE] | ||
|
||
|
||
#### Additional details / error screenshots | ||
|
||
- ![Screenshot] | ||
- |
43 changes: 43 additions & 0 deletions
43
.github/ISSUE_TEMPLATE/camunda-community-hub-pull-request-template.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,43 @@ | ||
--- | ||
name: Camunda Community Hub Pull Request Template | ||
about: Use this template when opening a new pull request in a Camunda Community extension repository. | ||
title: '' | ||
labels: '' | ||
assignees: '' | ||
|
||
--- | ||
|
||
# Camunda Community Hub Pull Request Template | ||
|
||
<!--- Provide a general summary of your changes in the issue title above. Do not @ GitHub users in your pull request title. If your extension is still a work in progress, please add [WIP] to the title so that your pull request will not be flagged as mergable. When your PR is ready to be merged, you can remove [WIP] from the title. --> | ||
|
||
## Description | ||
<!--- Describe your pull request in detail here --> | ||
|
||
## Additional context | ||
<!--- Why is this change needed? What problem does it solve? --> | ||
<!--- If it fixes an open issue, please link to the issue here. --> | ||
|
||
## Testing your changes | ||
<!--- Please describe in detail how you tested your changes. --> | ||
<!--- Include any relevant details as to your testing environment, and any tests you ran to determine how/if your change impacts other areas of the extension's codebase, etc. --> | ||
|
||
## Types of changes | ||
<!--- What types of changes does your code introduce? Put an `x` in all the boxes that apply: --> | ||
- [ ] Bug fix (non-breaking change which fixes an existing open issue) | ||
- [ ] New feature (non-breaking change which adds functionality to an extension) | ||
- [ ] Breaking change (fix or feature that would cause existing functionality of an extension to change) | ||
- [ ] Documentation update (changes made to an existing piece of documentation) | ||
|
||
## Checklist: | ||
<!--- Please review the following points, and put an `x` in all the boxes that apply. --> | ||
<!--- If you're unsure about any of these, don't hesitate to ask. We're here to help! --> | ||
- [ ] My code adheres to the syntax used by this extension. | ||
- [ ] My pull request requires a change to the documentation. | ||
- [ ] I have updated the documentation accordingly. | ||
- [ ] I have read the **Camunda Community Hub** documentation. | ||
- [ ] I have read the **Pull Request Process** documentation. | ||
- [ ] I have added or suggested tests to cover my changes suggested in this pull request. | ||
- [ ] All new and existing CI/CD tests passed. | ||
- [ ] I will /assign myself this issue, and add the relevant [issue labels] to it if they are not automatically generated by Probot. | ||
- [ ] I will tag @/camunda-community-hub/devrel in a new comment on this issue if 30 days have passed since my pull request was opened and I have not received a response from the extension's maintainer. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,13 @@ | ||
## Describe the ideal solution or feature request | ||
A clear and concise description of what you would like to see happen with the addition of this feature. | ||
|
||
## Difficulty, impact, and usage score | ||
| Technical difficulty | User goals | Usage frequency | | ||
|--------------------| --------------------| --------------------| | ||
| ie. Small, medium, large (filled out after submission) | ie. How important is this, what do you want to accomplish | ie. Daily, weekly, monthly | | ||
|
||
## How does this tie into the project or extension? | ||
Describe whether this request is related to an existing workflow, feature, or something that already exists in the extension or project today. | ||
|
||
## Who would benefit from this? | ||
Add more on who would benefit from this feature, ie. individual developers, end users, existing customers using the extension, etc. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,3 @@ | ||
# Code of Conduct | ||
|
||
### View the [Camunda Code of Conduct](https://camunda.com/events/code-conduct/) and find ways to report violations. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,71 @@ | ||
# Contributing | ||
|
||
Hi there! We're thrilled that you'd like to contribute to this project. Your help is essential for keeping it great. | ||
|
||
Please note that this project is released with a [Contributor Code of Conduct](https://github.com/camunda-community-hub/community/blob/main/CODE_OF_CONDUCT.MD). By participating in this project you agree to abide by its terms. | ||
- [Issues and PRs](#issues-and-prs) | ||
- [Submitting a pull request](#submitting-a-pull-request) | ||
- [Non-Code Camunda community extension contributions](#non-code-camunda-community-extension-contributions) | ||
- [Event-Based community roles](#event-based-community-roles) | ||
- [Community education and onboarding](#community-education-and-onboarding) | ||
- [Issue triage](#issue-triage) | ||
- [Post-Code specific contributions](#post-code-specific-contributions) | ||
- [Help project maintainers write release notes for their extension](#help-project-maintainers-write-release-notes-for-their-extension) | ||
- [Resources](#resources) | ||
|
||
## Issues and PRs | ||
|
||
If you have suggestions for how this project could be improved, or want to report a bug, open an issue! We'd love all and any contributions. If you have questions, too, we'd love to hear them. | ||
|
||
We'd also love PRs. If you're thinking of a large PR, we advise opening up an issue first to talk about it, though! Look at the links below if you're not sure how to open a PR. | ||
|
||
## Submitting a pull request | ||
|
||
Please feel free to fork this repository and open a pull request to update this documentation. | ||
|
||
Work in Progress pull requests are also welcome to get feedback early on, or if there is something blocking you that you would like an additional person to take a look at. | ||
|
||
## Non-Code Camunda community extension contributions | ||
|
||
If you are interested in contributing to any Camunda Community Hub extension, there are a variety of ways to get involved without having to have coding experience: These include issue triage, writing documentation, and much, much more. | ||
|
||
### Event-Based community roles | ||
|
||
* Host or organize a Camunda Community Meetup | ||
* Present your work with Camunda at Meetups | ||
* Start a new Camunda event near you | ||
|
||
### Community education and onboarding | ||
|
||
* Help new contributors get started working with the Hub, finding a repository to contribute to, forking a repo, and making their first pull request | ||
* Getting people involved in writing documentation and issue triage | ||
* Spreading the word about the Camunda Community Hub to the broader open source community | ||
* Answering questions on Slack, Discourse, GitHub Project boards, and the Camunda Cloud community forums | ||
* Create community content | ||
* Write a blog post about your experience with Camunda, how you built a Community Hub Extension, etc. | ||
* Be a guest on our Camunda Nation podcast | ||
* Write walkthroughs, how-to guides, and more | ||
|
||
### Issue triage | ||
|
||
* Labelling issues in Camunda Community Extension repositories | ||
* Helping to triage issues by following up where needed, closing stale issues, and more | ||
* For more information on how to get started with issue triage and labelling, including what issue labels and pull request automation we use in the Camunda Community Hub, please read the [documentation](https://github.com/camunda-community-hub/community/blob/main/issue-triage.md) | ||
|
||
### Post-Code specific contributions | ||
|
||
These are roles that are not code-based, but require some knowledge in that you will need to have an understanding of the Camunda Community Extension ecosystem, the Camunda codebase, or general programming knowledge. | ||
|
||
### Help project maintainers write release notes for their extension | ||
|
||
* GitHub management (tags, repositories, etc.) | ||
* Mentoring new contributors and ensuring they have the tools they need to succeed when contributing to a Camunda Community Hub open source project | ||
* Writing new or editing existing documentation | ||
* Updating communication guidelines and expectations | ||
|
||
## Resources | ||
|
||
- [How to Contribute to Open Source](https://opensource.guide/how-to-contribute/) | ||
- [Using Pull Requests](https://help.github.com/articles/about-pull-requests/) | ||
- [GitHub Help](https://help.github.com) | ||
- [CODE_OF_CONDUCT](https://github.com/camunda-community-hub/community/blob/main/CODE_OF_CONDUCT.MD) |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,8 @@ | ||
[![Community Extension](https://img.shields.io/badge/Community%20Extension-An%20open%20source%20community%20maintained%20project-FF4700)](https://github.com/camunda-community-hub/community) | ||
[![](https://img.shields.io/badge/Lifecycle-Incubating-blue)](https://github.com/Camunda-Community-Hub/community/blob/main/extension-lifecycle.md#incubating-) | ||
|
||
# Welcome to the Camunda Community Hub Repository Template! | ||
|
||
The Camunda Community Hub is a project to empower our open source community extension maintainers, and encourage new contributors to get started contributing to the Camunda open source ecosystem. | ||
|
||
If you are building a new Camunda Community extension, please follow the instructions detailed in our [Community Repository](https://github.com/camunda-community-hub/community). Once those steps had been completed, please feel free to make use of this repository to build your new extension from! |