Review public API

Open
#672 0 comments 0 reactions 0 assignees View on GitHub

Maintainers usually reply within 2 days

Nobody has claimed this yet.

Assessment

Difficulty
5/5
Estimated time
Over a week
Newbie friendliness
25/100
Issue type
Feature
Clarity
Needs clarification
Activity status
Stale
Tech stack
c

Research direction

Start by reading the public API declarations and documentation for srtp_policy_set_ssrc, srtp_policy_add_key, and the error codes. Compare their style and usage, then identify which proposed API changes are necessary and agree on their scope before making changes. The issue does not specify files, tests, or acceptance criteria, so completion needs those decisions.

Written by the indexing model from the issue text.

Description

Go over the public api and ensure it is consistent in style and wording

  • Try to make policy api simpler by removing needed for srtp_policy_set_ssrc
  • Go over srtp_policy_add_key , maybe add api to retrieve keys
  • review error codes, both the name and if they are used. Maybe add some more specific ones
Dominant language
C
Stars
1.4k
Forks
523
Avg merge
3d 23h
Merged PRs (30d)
14

Getting set up

This project ships no dev container, Dockerfile or contributing guide, so setting up is up to you: start from its README, and see our first-contribution guide for the general steps.

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from cisco/libsrtp

All issues in cisco/libsrtp

Similar issues

More C issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.