Skip to content

Latest commit

 

History

History
85 lines (59 loc) · 4.6 KB

CONTRIBUTING.MD

File metadata and controls

85 lines (59 loc) · 4.6 KB

Contributor Guide

Hi there! We're thrilled that you'd like to contribute to this or other projects in the Camunda Community Hub.

Please note that this project is released with a Contributor Code of Conduct. By participating in this organization, 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. Look at the links in Resources if you're not sure how to open a PR.

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.

For more guidance around pull requests, visit our Pull Request Process.

Code contributions

While we have general guidelines, each community extension has its own preferences for accepting contributions. Check the repo for any specific guidance for contributing code. We also have guidelines for Maintainer and Reviewer expectations.

Non-code contributions

If you are interested in contributing to any Camunda Community Hub extension, there are a variety of ways to get involved without needing coding skills. These include issue triage, writing documentation, and much, much more.

Event-based community roles

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 the Camunda forums, Stack Overflow, GitHub Project boards
  • Create content around Camunda and Community Hub projects
  • Write a blog post about your experience with Camunda, how you built a Community Hub extension, etc.
  • Be a guest on our Camunda Community 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.

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

Camunda contributions

Getting started with open source