aws / aws/aws-encryption-sdk-c

Best Practices developer guide for aws-c-commons data structure usage

Open
#375 0 comments 0 reactions 0 assignees View on GitHub
Dominant language
C
Stars
63
Forks
59
PR merge metrics
No merged PRs in 30d

Description

Write a developer guide with best practice patterns and guidance for how to use the various data structures in aws-c-common with our code. The memory use patterns are not all consistent and there’s a bit of trickiness there that can trip up new developers.

- strings
- hash maps
- byte buffers
- cursors, etc.

Contributor guide

Open the contributing guide

Research direction

Start by surveying how this repository uses aws-c-common strings, hash maps, byte buffers, and cursors, paying particular attention to the inconsistent memory-use patterns mentioned in the issue. Done means a developer guide documents best-practice usage and guidance for each listed data structure, including pitfalls that could confuse new developers.

Written by the indexing model from the issue text.

Assessment

Tech stack
c
Domain
documentation
Issue type
Documentation
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
38/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.