Differences

This shows you the differences between two versions of the page.

--- github [2023/10/17 18:19] – A 'normal work flow' might have been documented in the FreeBSD Handbook in 2017 (revision 6), but I don't see it there now. Instead: 'documents such as Contributing to FreeBSD'. GrahamPerrin
+++ github [2023/10/18 07:13] (current) – Refer to 'How to Become a FreeBSD Translator' for pull requests that are translation submissions. GrahamPerrin
@@ Line 1: / Line 1: @@
 ===== GitHub =====
-%%FreeBSD%% maintains a GitHub presence, with the [[https://github.com/freebsd|FreeBSD GitHub Organisation]], its repositories, svn2git integration and mirroring managed by [[GitAdmin]].
+https://github.com/freebsd — the %%FreeBSD%% organisation on GitHub.
-For repositories where pull requests (PRs) are not officially accepted:
-  * some Project members may process requests
-  * the recommended method for submitting changes is via [[Bugzilla]].
 ===== Repositories =====
@@ Line 14: / Line 9: @@
   * [[https://github.com/freebsd/freebsd-doc|freebsd-doc]] — %%FreeBSD%% Documentation Project (FDP)
     * pull requests are accepted
-    * [[https://docs.freebsd.org/en/articles/contributing/#contrib-general|no guidelines/policy for PRs]]
+    * 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]]
@@ Line 34: / Line 30: @@
   * [[https://github.com/freebsd/poudriere|poudriere]] — port/package build and test system.
-===== Joining =====
+===== Pull Requests (PRs) =====
-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.
+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]]).
-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.
+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.
-===== Pull Requests (PRs) =====
+If the PR will be **significantly less simple** — with consensus building, discussion, or rework — there may be closure without commit.
-This is an experimental approach for the %%FreeBSD%% Project. While efforts are given to PRs, a more traditional workflow may be more reliable — see documents such as [[https://docs.freebsd.org/en/articles/contributing/|Contributing to FreeBSD]].
+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.
-PRs that include source code ready to go into the tree, or only need light editing to resolve conflicts or other trivial issues will be merged. PRs that require consensus building, discussion and or rework will be closed and redirected into the project's normal work flow. PRs may require maintainer approval before being merged, which we'll try to facilitate. If you don't receive timely resolution via this means, please consider using the project's mailing lists, contacting maintainers directly, [[Bugzilla]], [[Phabricator]], etc to speed resolution.
+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 =====
-There are webhooks configured on some %%FreeBSD%% Organisation repositories. This section details who configured them and what they're in use for. All external configurations or integrations should be listed here.
+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-src, freebsd-ports, freebsd-doc
+    * Repositories: freebsd-doc, freebsd-ports, freebsd-src
     * Contact: KubilayKocak
   * Discord Messages for commit events:
     * Endpoint: dev.wired.sh Purpose: [[Discord]] commit events
-    * Repositories: freebsd-src, freebsd-ports, freebsd-doc
+    * Repositories: freebsd-doc, freebsd-ports, freebsd-src
     * Contact: KubilayKocak LewisCook
 ===== Contact =====
-  * For general questions, email [[GitAdmin#Contact|Git Admin]]
+The [[https://github.com/freebsd|organisation]], its repositories, and mirroring, are managed by the [[GitAdmin|Git Admin]] team.
-  * 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]]
+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]]
 ----