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 3f5f0ef
Showing
5 changed files
with
191 additions
and
0 deletions.
There are no files selected for viewing
44 changes: 44 additions & 0 deletions
44
.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,44 @@ | ||
--- | ||
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 @celanthe 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 |
36 changes: 36 additions & 0 deletions
36
.github/ISSUE_TEMPLATE/new-community-extension-proposal-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,36 @@ | ||
--- | ||
name: New Community Extension Proposal Template | ||
about: Use this template when proposing a new Camunda Community Hub Extension | ||
title: '' | ||
labels: '' | ||
assignees: '' | ||
|
||
--- | ||
|
||
# Camunda Community Hub Extension Proposal | ||
|
||
<!-- Use this template to propose a new extension in the Camunda Community Hub. Remember to add the kind/extension-proposal label in a new comment, its lifecycle label, and any other labels necessary to help others evaluate and contribute to your extension. --> | ||
|
||
### Extension description | ||
<!-- Add a description of your extension here. --> | ||
|
||
### Suggested use case | ||
<!-- Add a description of your extension's suggested use case/what it will most likely be used for on a daily basis here. --> | ||
|
||
### Configuration | ||
<!-- Add a description of how to configure your extension here. --> | ||
|
||
### Dependencies | ||
<!-- Add a description of your extension's required dependencies here. --> | ||
|
||
### Issues/Challenges | ||
<!-- Add a description of any issues/challenges that those using your extension might face here. If you don't feel there are any, you can write, 'None,' here. --> | ||
|
||
### Extension lifecycle | ||
<!-- Add a description of where your extension falls in the Camunda Community Hub extension lifecycle here. Don't forget to add the applicable lifecycle/ label in a new comment on this issue! Note that if your extension is brand new, the label to apply to it should always be proof-of-concept. --> | ||
|
||
### Additional Context | ||
<!-- Add any additional context you feel is relevant to your proposal here. --> | ||
|
||
### Maintainer Needed? | ||
<!-- if you wish to be the Maintainer for this extension, say, 'No,' here. If you're just making a suggestion for a new extension and *do not* want to maintain the extension, enter the text, 'This extension is actively seeking a maintainer' and add the lifecycle/needs-maintainer label to the issue in a new comment. --> |
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,64 @@ | ||
# [Camunda Community Hub Code of Conduct](https://camunda.com/events/code-conduct/) | ||
|
||
## Community Standards | ||
|
||
Our awesome community is what makes us who we are. We’re extremely proud that our community members come from all around the world and from various backgrounds. We want to provide each and every one of you with a consistently great experience, so we created this Community Code of Conduct. We want to ensure that mutual support will always be guaranteed and that we create an environment in which we can grow together. | ||
|
||
As is the nature of open source software, maintainers and extension creators often wear many hats. These range from administrative, to QA, and much more. | ||
As extensions in the Camunda Community Hub are community led, it is crucial that users of extensions understand that Maintainers are often working on community extensions in their free time. | ||
|
||
Please remember to be kind, and follow the Camunda Code of Conduct when interacting with other Camunda community members. Keep in mind that communication styles vary, and no two individuals communicate in the same way. Please do your best to remain helpful, and try to avoid making sweeping demands whenever possible. | ||
|
||
It is expected that Maintainers will follow the Code of Conduct when interacting with community members, and the same holds true for community members interacting with project Maintainers. | ||
|
||
### Scope | ||
We expect all members of the Camunda community, including administrators, users, facilitators, and vendors to abide by this Code of Conduct at all times. | ||
|
||
The Camunda Code of Conduct applies to all our Camunda projects and products, including but not limited to Camunda Platform, Camunda Cloud, the Camunda Community Hub, and [bpmn-io](https://bpmn.io/). It also applies to all Camunda events. This includes official Camunda events, such as CamundaCon, Camunda Process Automation Forums, Camunda meetups, trainings, workshops, and unofficial Camunda events. | ||
|
||
The Camunda Community Code of Conduct also applies to any Camunda online space. This includes Slack workspaces, discussion forums, websites, code repositories, mailing lists and more. The Camunda Community Code of Conduct also applies to private correspondence between community members through our online spaces. | ||
|
||
We trust all of our community members will help to create a safe and welcoming environment for everyone. | ||
|
||
### Creating a Harrassment-Free Space | ||
|
||
We are dedicated to providing a harassment-free community space for everyone, regardless of gender, gender identity and expression, sexual orientation, disability, physical appearance, body size, ethnicity, age, physical appearance, religion or similar personal characteristics. | ||
|
||
We do not tolerate harassment of other Camunda users in any form, whether publicly or privately. Harassment includes, but is not limited to: harmful or prejudicial verbal or written comments, inappropriate use of nudity, sexual images, and/or sexually explicit language in public spaces; threats of physical or non-physical harm; deliberate intimidation, stalking or following; harassing photography or recording; sustained disruption of talks or other events; inappropriate physical contact; and unwelcome sexual attention. | ||
|
||
In addition, any spamming, trolling, flaming, baiting, or other attention-stealing behaviour is not welcome, and will not be tolerated. | ||
|
||
### Community Guidelines | ||
|
||
We have put together a few guidelines that we ask community members to adhere to. By being explicit about them, we want to ensure that the Camunda community continues to be a supportive place for everyone: | ||
|
||
* Mutual respect: No matter if you are an administrator, user, facilitator or vendor – please beware of inappropriate behavior and wording at any time. | ||
* Camunda stands for open communication, respectful interaction and transparency – please keep that in mind, as we strive for an inspiring environment where every single member and participant feels welcome. | ||
* Effective communication: “To effectively communicate, we must realize that we are all different in the way we perceive the world and use this understanding as a guide to our communication with others” (Tony Robbins). By listening to understand rather than to respond, we will create a highly productive environment where all community members, no matter what language or background, will be able to communicate effectively. | ||
* Mindfulness: Please be mindful of the space, as well as people and their actions around you. We always co-create and every single action can have a major impact on the event or even the community. To create this safe, supportive and highly productive space we need to work together and hold each other accountable. | ||
* Request and provide support: Our online as well as offline platforms are meant to support exchange and mutual help. Please be open with your requests and questions as there is a good chance not only you, but the whole community can benefit from starting the conversation. In return, please be open to share your knowledge and experience to be an active member of the community. | ||
* No tolerance for harassment: We do not tolerate harassment of other Camunda community members in any form, whether publicly or privately. See above (our standards) for further specification of types of harassment. | ||
|
||
### Reporting Violations | ||
|
||
Harassment and other code of conduct violations reduce the value of our community for everyone. We want you to be happy when engaging with the broader Camunda community. | ||
If someone makes you or anyone else feel unsafe or unwelcome, [report it as soon as possible](https://camunda.com/events/code-conduct/reporting-violations/), to help us make the community a better place, please include as much detail as possible in your report as it is easier for us to address issues when we have more context. If this issue is able to be documented, it is helpful to include screenshots. | ||
|
||
### Violations to the Community Code of Conduct | ||
Harassment and unacceptable behavior from any community member, including employees, sponsors, customers, partners, event organizers, or others with decision-making authority, will not be tolerated. | ||
|
||
Anyone asked to stop unacceptable behavior is expected to comply immediately. If a community member engages in unacceptable behavior, the Camunda administrators may take any action they deem appropriate, up to and including a temporary or permanent ban from the community without warning and without refund in the case of a paid event or service. | ||
|
||
### Communication Styles | ||
|
||
When communicating with others on the Camunda Cloud Community forums or in Slack, it’s important to remember that not everyone communicates in the same way. | ||
Some individuals may be [neurodivergent](https://autisticuk.org/neurodiversity/), and thus may not communicate in a neurotypical manner. | ||
Please endeavor to understand [neurological differences](https://www.bbc.co.uk/neurodiversity) when communicating with other community members, so that this space is welcoming for everyone. | ||
|
||
Others may learn or understand information differently from you. While someone may understand a diagram or Model at first glance, others may benefit from having a paragraph or two of information to read that explains what the diagram, Model, or example does. | ||
Remember that what may seem obvious to you may not be to someone else. | ||
|
||
We all come from different backgrounds and experiences. As such, keep in mind that not everyone has had access to the same learning tools, education, and experience that you may have. | ||
What may seem like an, “Easy,” or, “Quick,” solution for you may be difficult to understand, or challenging to implement for someone else. | ||
|
||
Above all, please be compassionate and empathetic when communicating with others. |
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,40 @@ | ||
# Contributing | ||
|
||
[fork]: /fork | ||
[pr]: /compare | ||
[CODE_OF_CONDUCT]: CODE_OF_CONDUCT.MD | ||
|
||
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 | ||
|
||
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 | ||
|
||
1. [Fork][fork] and clone the repository. | ||
1. Configure and install the dependencies: `npm install`. | ||
1. Make sure the tests pass on your machine: `npm test`, note: these tests also apply the linter, so there's no need to lint separately. | ||
1. Create a new branch: `git checkout -b my-branch-name`. | ||
1. Make your change, add tests, and make sure the tests still pass. | ||
1. Push to your fork and [submit a pull request][pr]. | ||
1. Pat yourself on the back and wait for your pull request to be reviewed and merged. | ||
|
||
Here are a few things you can do that will increase the likelihood of your pull request being accepted: | ||
|
||
- Write and update tests. | ||
- Keep your changes as focused as possible. If there are multiple changes you would like to make that are not dependent upon each other, consider submitting them as separate pull requests. | ||
- Write a [good commit message](http://tbaggery.com/2008/04/19/a-note-about-git-commit-messages.html). | ||
|
||
Work in Progress pull requests are also welcome to get feedback early on, or if there is something blocked you. | ||
|
||
### 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,7 @@ | ||
# Welcome to the Camunda Community Hub Repository Template! | ||
|
||
## 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 have been completed, please feel free to make use of this repository to build your new extension from! | ||
|
||
|