awslabs / awslabs/aws-encryption-sdk-specification

update PR template to ask about contributing issues

Open
#77 0 comments 0 reactions 0 assignees View on GitHub
Dominant language
JavaScript
Stars
37
Forks
27
PR merge metrics
No merged PRs in 30d

Description

As discussed here[1], we should update the PR template to remind the author to add the contributing issue to the spec document if needed.

We will also need to define the criteria for this. For example, if the PR is just fixing typos or formatting then this is not necessary but if the PR is changing something about the spec then this is critical.

[1] https://github.com/awslabs/aws-encryption-sdk-specification/pull/74#discussion_r393369683

Contributor guide

Open the contributing guide

Research direction

Start by reading the pull request template and the discussion linked in PR 74, then review how contributing issues are recorded in the specification document. Define when a PR must reference an issue in that document, update the template with the reminder and criteria, and verify that typo or formatting-only changes are exempt.

Written by the indexing model from the issue text.

Assessment

Domain
documentation
Issue type
Documentation
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.