Contribution how-to
  • 14 Feb 2022
  • 1 Minute to read
  • Dark
    Light

Contribution how-to

  • Dark
    Light

In Ant Media, we do all of our development on GitHub. If you are not familiar with GitHub or pull requests, here is an excellent guide to get started.

Finding an issue

Here's a list of all our current projects. We use GitHub issues associated with each project to track the work associated with that project. That's where you can find things to work on.

We try to make extensive use of issue labels to designate the priority, status and beginner-friendliness of various issues. You may want to start with one of them that matches your capability and send a PR to us to review.

Contribution process

Once you've found an issue you'd like to work on, please follow these steps to make your contribution:

  • Comment on it and say you're working on that issue. This is to avoid conflicts with others also working on the issue.
  • Write your code and submit your pull request. 
  • Wait for code review and address any issues raised as soon as you can.

A note on collaboration: We encourage people to collaborate as much as possible. We especially appreciate contributors reviewing each others' pull requests, as long as you are kind and constructive when you do so.

Sending a new issue

If you want to work on something that there is no GitHub issue for, follow these steps:

  • Create a new GitHub issue associated with the relevant Ant Media repository and propose your change there. Be sure to include implementation details and the rationale for the proposed change.
  • Important: we are very reluctant to accept random pull requests without a related issue created first.
  • Wait for a project maintainer to evaluate your issue and decide whether it's something that we will accept a pull request for.

Once the project maintainer has approved the issue, you may start work on the code. When in doubt, please ask a question to one of our community forums.

Communication is key

Communication throughout the contribution process is extremely critical to open source development. If you are stuck on a PR, not sure how to address feedback, or don’t understand the logic, please ask your questions in our forum. By communicating clearly, you ensure everyone working on a project around the world is informed, saving time and minimizing items that get lost in translation.


Was this article helpful?

What's Next