GitHub [FreeBSD WIKI]

This page is read only. You can view the source, but not change it. Ask your administrator if you think this is wrong.
===== GitHub =====

https://github.com/freebsd — the %%FreeBSD%% organisation on GitHub.

===== Repositories =====

Secondary mirrors of ''%%doc%%'', ''%%ports%%'', and ''%%src%%'' trees:

  * [[https://github.com/freebsd/freebsd-doc|freebsd-doc]] — %%FreeBSD%% Documentation Project (FDP)
    * pull requests are accepted
    * translation submissions are mentioned under [[https://docs.freebsd.org/en/books/fdp-primer/weblate/#weblate-become-translator|How to Become a FreeBSD Translator]] in the %%FreeBSD%% Documentation Project Primer for New Contributors
    * [[https://docs.freebsd.org/en/articles/contributing/#contrib-general|no guidelines/policy for other types of PR]]
  * [[https://github.com/freebsd/freebsd-ports|freebsd-ports]] — the ports collection
    * pull requests are [[https://docs.freebsd.org/en/articles/contributing/#contrib-general|subject to the whims of developers]]
    * better follow the guidelines for [[https://docs.freebsd.org/en/articles/contributing/#ports-contributing|contributing to ports]]
  * [[https://github.com/freebsd/freebsd-src|freebsd-src]] — %%FreeBSD%% base
    * pull requests are preferred for relatively straightforward changes, where the contributor already has a %%GitHub%% account
    * [[https://github.com/freebsd/freebsd-src/blob/main/CONTRIBUTING.md#contribution-guidelines-for-github|guidelines for contributors]] were introduced in February 2023 ([[https://github.com/freebsd/freebsd-src/commits/main/CONTRIBUTING.md|history]]).

[[Ports]]-specific projects and teams:

  * [[https://github.com/freebsd/freebsd-ports-gnome|freebsd-ports-gnome]] — GNOME
  * [[https://github.com/freebsd/freebsd-ports-kde|freebsd-ports-kde]] — QT & KDE.

Primary repositories — issues and pull requests welcome — for other well-known projects include:

  * [[https://github.com/freebsd/drm-kmod|drm-kmod]] — the DRM drivers ported from Linux to %%FreeBSD%% using %%LinuxKPI%%
  * [[https://github.com/freebsd/pkg|pkg]] — a binary package manager for %%FreeBSD%%
  * [[https://github.com/freebsd/portmaster|portmaster]] — port management script without external databases or languages 
  * [[https://github.com/freebsd/poudriere|poudriere]] — port/package build and test system.

===== Pull Requests (PRs) =====

This is an experimental approach for the %%FreeBSD%% Project. While efforts are given to PRs, a more traditional workflow may be more likely to succed (please see documents such as [[https://docs.freebsd.org/en/articles/contributing/|Contributing to FreeBSD]]).

A **simple** PR — non-contentious tree-ready source code, or code that needs only light edition (trivial issues such as merge conflicts) — will be merged, or closed with reference to the commit of the code.

If the PR will be **significantly less simple** — with consensus building, discussion, or rework — there may be closure without commit.

A PR may require maintainer approval, which we'll try to facilitate. If approval is not timely: consider [[https://www.freebsd.org/community/mailinglists/|mailing lists]], [[Bugzilla]], [[Phabricator]], or direct contact with maintainers.

For repositories where PRs are not officially accepted:

  * some Project members may process requests
  * the recommended approach to code changes is [[Bugzilla]].

===== Joining the Organisation =====

Requests to be added to the [[https://github.com/freebsd|FreeBSD GitHub Organisation]] can be made via [[https://bugs.freebsd.org/bugzilla/buglist.cgi?product=Services&component=Git%20Integration&resolution=---|Bugzilla]] (Product: Services, Component: Git Integration). Please include details of any teams you are a member of or hats you wear so that this can be reflected in GitHub.

Currently, in almost all cases, only those with @%%FreeBSD%%.org accounts are approved. External users //may// apply to be a part of the organisation if a compelling case can be made. Examples may be external contributors that require write (commit) access to a %%FreeBSD%% repository other than src, ports, and doc that is hosted within the organisation account.

===== Webhooks =====

Webhooks are configured on some repositories. This section details the purpose of each hook, and who configured it.

All external configurations or integrations should be listed here.

  * IRC Messages for commit events:
    * Endpoint: n.tkte.ch Purpose: IRC (freenode) commit events
    * Repositories: freebsd-doc, freebsd-ports, freebsd-src
    * Contact: KubilayKocak

  * Discord Messages for commit events:
    * Endpoint: dev.wired.sh Purpose: [[Discord]] commit events
    * Repositories: freebsd-doc, freebsd-ports, freebsd-src
    * Contact: KubilayKocak LewisCook

===== Contact =====

The [[https://github.com/freebsd|organisation]], its repositories, and mirroring, are managed by the [[GitAdmin|Git Admin]] team.

For general questions, email [[GitAdmin#Contact|Git Admin]].

For change requests (new repositories, permissions, etc), please create an issue in [[https://bugs.freebsd.org/bugzilla/buglist.cgi?product=Services&component=Git%20Integration&resolution=---|Bugzilla -- Services:Git Integration]]

----

{{tag>Services}}