Skip to content

Latest commit

 

History

History
33 lines (20 loc) · 1.88 KB

CONTRIBUTING.md

File metadata and controls

33 lines (20 loc) · 1.88 KB
Raw

How to contribute

We're really glad you're reading this, because we need developers to help to maintain this project.

Before filing a bug report or pull request, please ensure that you're reporting to the correct repository! This repository is pjsip built for iOS/macOS and published on CocoaPods. If you've found a bug within pjsip itself, this is the wrong place and you'd rather go visit pjsip.org.

Here are some important resources:

  • README tells you what this project is about,
  • Our roadmap is the last commits to this project
  • Bugs? Issues is where to report them

Submitting changes

Please send a GitHub Pull Request to pjsip with a clear list of what you've done (read more about pull requests). When you send a pull request, we will love you forever if you include detailed documentation. Please follow our coding conventions (below) and make sure all of your commits are atomic (one feature per commit).

Always write a clear log message for your commits. One-line messages are fine for small changes, but bigger changes should look like this:

$ git commit -m "A brief summary of the commit
> 
> A paragraph describing what changed and its impact."

Coding conventions

Start reading our code and you'll get the hang of it. We optimize for readability:

  • We indent using four spaces (soft tabs)
  • This is open source software. Consider the people who will read your code, and make it look nice for them. It's sort of like driving a car: Perhaps you love doing donuts when you're alone, but with passengers the goal is to make the ride as smooth as possible.

Thanks,

pjsip maintainers