How to contribute

To contribute to free5GC project, you can consider to:

1. Raise the GitHub issue

You can create the Issue on the free5GC repo directly.
A issue could be 1. bugs report or 2. feature request, each issue would be assigned to the free5GC commiter by project owner, then assignee will solve the problem asap.

2. Create the Patch (Pull Request)

The source code of the free5GC is stored at https://github.com/free5gc/free5gc.
Please follow the GitHub flow for collaboration.

Note

Our pull request commit messages must comply with the Conventional Commit Message format.
This will be checked by the pull request CI action.

Design Documents

We maintain the design documents to help people started contributing to the free5GC, it includes the following topics:
1. Software Architecture
2. Dedicated issue and solution
3. Domain knowledges for 5GC development

• AMF
• AUSF
• SMF
• UPF (GTP5G)
• UPF (PFCP)
• CHF
• PCF (Charging)
• OAuth2 on SBI
• Problem Details

Recommended Articles

• How to Contribute to Open Source

5G Docs/Specs

• Tech-invite (3GPP Specs)
  • For beginner: TS 23.501, 23.502
  • NF Service: TS 29.50X
• Awesome 5G
• 5GC APIs

Development Skills

• Golang
  • A tour of go
  • https://github.com/uber-go/guide
• Version Control
  • https://git-scm.com/
  • https://docs.github.com/en/get-started/using-github/github-flow