Skip to content

Definition of a good-first-issue for the Dapr org #527

@marcduiker

Description

@marcduiker

To enable new contributors to Dapr to pick up new issues easily, it is important to create GitHub issues targeted to these contributors. These issues are known as good-first-issues, and they have a dedicated label in the Dapr repositories to identify them as such.

Unfortunately, most of these issues are not clear and thus hard to pick up by new contributors. I suggest we strive to use a good-first-issue format (or template) which makes it easier for people to understand the issue and contribute to Dapr.


A good first issue in the Dapr org should contain the following sections:

Current behavior

Describe what the current behavior is.

Steps to reproduce

Describe how to get to the current behavior.

Expected behavior

Describe what the expected behavior is.
Also include what it should NOT do if you think that is important.

Acceptance criteria

A list of criteria that must be completed before this issue is marked as completed
Does this require new unit tests?
Do existing unit tests need to be updated?
Are updates to the docs required?

Required skills & tools

Describe what technical skills and tools are required to work on this issue
Link to a contributing guide


Can the maintainers agree on the above sections? The community managers can help add some structure and context, but the majority of the work is still to be done by the maintainers/existing contributors.

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions