Page MenuHomeFreeBSD

Updating contributing article to include git instead of tar/shar
AcceptedPublic

Authored by freebsd_ny-central.org on Sun, May 19, 2:38 PM.
Tags
None
Referenced Files
Unknown Object (File)
Tue, May 21, 7:03 PM
Unknown Object (File)
Mon, May 20, 6:58 AM
Unknown Object (File)
Mon, May 20, 6:11 AM
Unknown Object (File)
Mon, May 20, 6:00 AM
Unknown Object (File)
Sun, May 19, 3:09 PM
Unknown Object (File)
Sun, May 19, 2:39 PM
Subscribers

Details

Reviewers
jrm
fernape
brooks
Group Reviewers
docs
Summary

This patch originated out of PR 278284, which indicated that tar and shar are outdated processes for change submissions.

There may probably be better people to speak to this to me, so I hope this is a step in the right direction. Feedback is very welcome.

I have

  • added reference to git format-patch as well as git diff
  • removed tar and shar in terms of the "de-facto" submission path
  • added Phabricator as review option
  • removed the hosting question to be asked from project members, since we now have Phabricator

Diff Detail

Repository
R9 FreeBSD doc repository
Lint
No Lint Coverage
Unit
No Test Coverage
Build Status
Buildable 57968
Build 54856: arc lint + arc unit

Event Timeline

fernape added a subscriber: fernape.

LGTM.

Thanks!

This revision is now accepted and ready to land.Sun, May 19, 3:46 PM

For non-ports contributions we should really discourage submissions via bugzilla unless it's what a specific committer you're working with wants. Generally, bugzilla is where patches go to die.

documentation/content/en/articles/contributing/_index.adoc
264–265

I think we should drop the mention of tar entirely. For things that Phabricator doesn't handle well (lots of renames, etc) GitHub PRs are more appropriate.

287

I'd drop FTP while you're here, it's archaic.

documentation/content/en/articles/contributing/_index.adoc
264–265

I think we should drop the mention of tar entirely. For things that Phabricator doesn't handle well (lots of renames, etc) GitHub PRs are more appropriate.

Agree.

287

Probably worth mentioning "... a web server or other online storage solution." so we cover google drive, dropbox, etc...

documentation/content/en/articles/contributing/_index.adoc
287

I guess so. Personally I want Phab or a GitHub PR. Anything else and the interest bar for looking at such submissions becomes very high.

freebsd_ny-central.org edited the summary of this revision. (Show Details)

I've done some additional updates based on your inputs. Additional feedback very
welcome, of course.

I've switched to arcanist now - if something's off with the patch, please let me
know - I might still have some of the config screwed up...

Suggestion for preliminary commit message (once we get there):

Instead of sending tar files and only filing patches as PR on
Bugzilla, contributions should instead by uploaded to Phabricator
or provided as pull requests on Github.

PR:             278274
Reported by:    brooks
Reviewed by:    brooks, fernape
This revision now requires review to proceed.Thu, May 30, 7:00 PM
freebsd_ny-central.org added inline comments.
documentation/content/en/articles/contributing/_index.adoc
287

I've removed any form of website and recommend Phabricator and Github only - is this a working compromise or should we mention these still?

This is an improvement.

I'm not convinced we should discuss any non-git contribution methods, but can certainly be committed as is.

This revision is now accepted and ready to land.Fri, May 31, 2:32 PM
documentation/content/en/articles/contributing/_index.adoc
252

Would linking directly to man:git-format-patch [1] here make sense? We already link to man:git[1] a few lines above.

261

We could also mention man:git-apply[1] here for when the patch was generated with git format-patch.

...(which you may test with man:patch[1] or man:git-format-patch[1])...