This page describes the process of submitting code to FreeSWITCH™.
Forking project with Stash
- Create a new account in JIRA.
- Create a new issue in JIRA, describing the feature you want to develop or the problem you're trying to fix.
- Login to Stash using your JIRA credentials: https://freeswitch.org/stash
After logging in, you'll see current projects hosted on Stash. Click on FreeSWITCH™ project link:
You'll see a list with all repositories, click on FreeSWITCH™:
In the repository page, hover over the ellipsis button on the left and click on the Fork option:
In the next screen, it'll ask for your fork name, it will default to FreeSWITCH and you can leave it like that as we'll work with branches to do our pull request. This will bring you to your fork repository:
In your new fork page, we need to enable public access. To do this, click on "Settings" on top of the page, and then "Repository" under "Permissions" and check the enable box under "Public Access":
Clone your fork
Ensure Git is Setup
Tell git your full name and email address – make sure to use your real name and not a username. Inside your FreeSWITCH source directory, run scripts/setup-git.sh:
Create your working branch
It's easier if you create a branch to work exclusively on the issue you'll fix, also, this makes easier to sync your fork repository since you're not committing to branches that aren't in the main repo.
There's two ways to create a branch, first is using git directly:
Or, you can use a link from the JIRA you'll work on. Take a look on the right side of the screen, there's a Create branch link:
Next screen, choose the branch type and name (the default one is good):
Now you can pull the new repo changes:
Checkout the branch:
Create Your Commits
Make your change:
Commit the results locally; see the Commit Guidelines for how to write a good commit message:
Please follow the commit guidelines, always reference the JIRA number and the module name the commit references with [my_module_name].
This makes easier to read commits and see which module is affected.
Create more commits as needed such that each commit represents a logically separate change:
Review changes and ensure your author name is correct:
Push changes to Stash
Create Pull Request
To create your Pull Request, go to Stash page and navigate to the repository which you want to contribute your changes, in this case FreeSWITCH™, and click “Pull Request” Button bottom left:
Select your repository and your branch, edit the Title (it will default to the branch name, there's must be a Jira id on it, in this case, FS-1234), the Description (it will auto populate with commit messages from commits on the branch not already in FreeSWITCH™ master repo):
Congratulations! You just created your first Pull Request.
Updating Pull Request with new code
If one of the developers ask you to modify your code, there's no need to create another pull request.
Each pull request tracks the branch from the forked repository, so when you commit more changes and pushes those changes to Stash, the pull request is automatically updated with the new commits.
Always create one branch for each pull request. If a developer asks for a change, make the change in the specific branch, and push the new change.
If you have not received feedback on your Pull Request by the regular Thursday Bug Hunt/Patch Review conference call, Call in to the bridge at 2PM US Central Time (1900 GMT) and ask to have your patch reviewed.
For more informations about our conference schedule, see ClueCon Weekly Conference call.