[Bug 298336] Porter's Handbook: Improve section "Submitting the New Port"

https://bugs.freebsd.org/bugzilla/show_bug.cgi?id=298336

            Bug ID: 298336
           Summary: Porter's Handbook: Improve section "Submitting the New
                    Port"
           Product: Documentation
           Version: Latest
          Hardware: Any
                OS: Any
            Status: New
          Severity: Affects Some People
          Priority: ---
         Component: Books & Articles
          Assignee: doc@FreeBSD.org
          Reporter: michaelo@FreeBSD.org

The section only says:
Giving a good description in the summary of the problem report makes the work
of port committers and triagers a lot easier. The expected format for new ports
is "[NEW PORT] category/portname short description of the port". Using this
scheme makes it easier and faster to begin the work of committing the new port.

This scheme I have used for the bug summary as well as the commit subject.
There seems to be several problems:
* Commit hooks reject the message
* It doesn't say what else should be in the commit message
* A fellow dev says that this is a good scheme:
> <CATEGORY>/<PORTNAME>: New Port
> 
> COMMENT/pkg-descr
> 
> WWW: <FROM WWW>

Makes sense, though the first line contradicts the current docs.

The Handbook and the commit hooks maybe need to be modified to take a more
formal approach into account. Right now, the format of the message at more or
less at the merge of the committer.

-- 
You are receiving this mail because:
You are the assignee for the bug.