4bff655952
Add doc/git-guide.md, a single entry point for the practical Git knowledge needed to contribute to OAI, consolidating the how-tos that were scattered across the documentation: - Setting up commit signing: moved from CONTRIBUTING.md, which keeps the normative DCO/Verified requirements and links to the guide; led by a compact SSH recipe, with the allowed_signers troubleshooting and a note on repository-level configuration for shared servers. - Managing your own branch: moved from code-style-contrib.md, which keeps the workflow policy and links to the guide; mentions git switch and covers fixup commits with git rebase --autosquash, including the --fixup=amend:<commit> variant. - Working with submodules: the update command and the unintended submodule-pointer-update pitfall seen in past PRs. - Recovering from mistakes: git restore --staged, git restore, git reset --soft/--hard, and git reflog. - Reusing conflict resolutions with git rerere: enabling, typical flow, inspecting, seeding from existing history, sharing the cache, and caveats, clarifying that contribution branches must keep a linear history while forks may carry merge commits. The guide is referenced from doc/README.md (Developer tools), code-style-contrib.md, and CONTRIBUTING.md. Guidance coupled to its own document is cross-linked instead of moved: clang-format.md (pre-commit hook), GET_SOURCES.md (branch and tag model), and doc_best_practices.md (docs: commit prefix). Also fix a typo in the T tracer addconsoletrace documentation. Signed-off-by: Andrea Lacava <thecave003@gmail.com>
2.3 KiB
Contributing to Duranta
We want to make contributing to this project as easy and transparent as possible.
- Create an account on GitHub. Only contributions
against
duranta-project/openairinterface5g/are accepted. - Fork the repository, and open pull requests for your contributions from your fork.
- The contributing policies are described in the corresponding documentation page.
- Sign the CLA either before doing making your first pull request or after submitting the pull request.
- Mandatory signing of all the commits using the email address used for CLA.
Commit Guidelines
Every pull request must pass two CI checks before it can be merged:
-
Developer Certificate of Origin (DCO): Each commit must include a
Signed-off-by:trailer in the commit message. Usegit commit -s(or--signoff). -
Verified commits: Each commit must be cryptographically signed using SSH or GPG keys to confirm its origin.
Signing Commits
GitHub supports commit signing using either SSH keys or GPG keys. For the step-by-step setup (key generation, Git configuration, registering the key on GitHub, and verifying signatures locally), see the commit signing section of the Git guide.
NOTE: If your commits are not signed, the CI framework will not accept the PR. For more information regarding contribution guidelines please check this document
License
By contributing to Duranta, you agree that your contributions will be licensed under
- CSSL v1.0 license: for RAN and UE related source code and test scripts
- CC-BY-4.0: All the documentation
- MIT: Orchestration (helm-charts, docker compose)
Certain files are using different licenses; you can read about them in NOTICE.