Working on your first Pull Request? You can learn how from this free series How to Contribute to an Open Source Project on GitHub
Third-party patches are essential for keeping the project going; We are a small team and need your help. There are a few guidelines that we need contributors to follow so that we can stay on top of things.
- Make sure you have a GitHub account
- Submit a ticket for your issue, assuming one does not already exist.
- Clearly describe the issue including steps to reproduce when it is a bug
- Make sure you fill in the earliest version that you know has the issue
- Fork the repository on GitHub
- Create a topic branch from where you want to base your work
- This is usually the master branch
- Only target release branches if you are certain your fix must be on that branch
- To quickly create a topic branch based on master;
git checkout -b fix/master/my_contribution master. Please avoid working directly on themasterbranch
- Comment your code
- Create junit tests to demonstrate your work
- Make commits of logical units
- Ensure the code is formatted in-line with our style guide
- Check for unnecessary whitespace with
git diff --checkbefore committing - Make sure you have added the necessary tests for your changes
- Run all the tests to assure nothing else was accidentally broken
- Push your changes to a topic branch in your fork of the repository
- Submit a pull request to the repository in which you're working
- General GitHub documentation
- GitHub pull request documentation
- red5 users mailing list
- StackOverflow
- Subreddit
- Gitter
- Eclipse Formatting
YourKit YourKit is kindly supporting open source projects with its full-featured Java Profiler. YourKit, LLC is the creator of innovative and intelligent tools for profiling Java and .NET applications. Take a look at YourKit's leading software products: