FreeRADIUS InkBridge

Contributing

For a person or company wishing to submit a change to the FreeRADIUS project the process can sometimes be daunting if you’re not familiar with "the system." This text is a collection of suggestions which can greatly increase the chances of your change being accepted.

Submit patches or diff’s to the FreeRADIUS project

GitHub is the preferred method for submitting code changes. You can email small diffs for a single change or file. For big changes, like a large patch or modifying several files, submit a pull request to the project’s GitHub repository. This approach helps the FreeRADIUS team manage contributions more effectively. It ensures that large or complex changes are properly tracked and discussed.

Describe your changes

Describe the technical details of the changes in your patch or commit.

Be as specific as possible. Avoid using vague descriptions like "update file X", "bug fix for file X", or "this patch updates subsystem X, please apply".

If your description gets too long, it may be a sign that you should split your commit, as explained in the next point.

Separate your changes

Separate each logical change into its own commit. For example, if your changes include both bug fixes and performance enhancements for a single module, separate those changes into two or more patches.

On the other hand, if you make a single change to numerous files, group those changes into a single commit. Thus a single LOGICAL change is contained within a single commit.

If one commit depends on another commit in order for a change to be complete, that is OK. Simply note "this commit depends on commit X" in the extended commit description.

If your commit includes significant whitespace changes these should also be broken out into another, separate, commit.

Patches via GitHub

See the Using GitHub page for how to contribute patches via GitHub.

Refer to Forking GitHub repositories for additional help on setting up your repository.

Diffs via Email

See the Email page for how to contribute patches via email.

Only small patches will be accepted via email. Large patches, or patches that modify a number of files MUST be submitted as a pull-request via GitHub.