Skip to content

Latest commit

 

History

History
85 lines (58 loc) · 4.46 KB

CONTRIBUTING.MD

File metadata and controls

85 lines (58 loc) · 4.46 KB
Raw

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. By participating in this project you agree to abide by its terms.

Testing Locally

asdf plugin test <plugin-name> <plugin-url> [--asdf-tool-version <version>] [--asdf-plugin-gitref <git-ref>] [test-command*]

#
asdf plugin test zbctl https://github.com/camunda-community-hub/asdf-zbctl.git "zbctl version"

Tests are automatically run in GitHub Actions on push and PR.

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

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