GitWikiSuggestions

From Git SCM Wiki
(Difference between revisions)
Jump to: navigation, search
(new page suggestions)
Line 37: Line 37:
 
<pre><nowiki>
 
<pre><nowiki>
 
[wiki:GitSource:Documentation/git-apply.txt git-apply.txt]
 
[wiki:GitSource:Documentation/git-apply.txt git-apply.txt]
</nowiki></pre>.
+
</nowiki></pre>
  
 
----
 
----
Line 47: Line 47:
  
 
== Best Practice Page ==
 
== Best Practice Page ==
* commit message: short summary\n\nlong description
+
* commit message: short summary (<80 characters and not the beginning sentence continuing in second line) \n\n long description
   Reason: emailed patches, oneline log, gitweb overview
+
   Reason: emailed patches, oneline log, gitweb overview.
 
   Some tools currently insert new lines after the first line if there is none. This may be considered as a bug and should be fixed.
 
   Some tools currently insert new lines after the first line if there is none. This may be considered as a bug and should be fixed.
* branching is easy and cheap, use it!
+
* branching is easy and fast, use it (encourage topic branches)
 
* rebase if you've been the only person working on the branch to prevent unnecessary merges (making the history complicated)
 
* rebase if you've been the only person working on the branch to prevent unnecessary merges (making the history complicated)
  
Line 61: Line 61:
 
   documentation seems to use a bit less than 80 for the textwidth most of the time, is there any recommendation for that?
 
   documentation seems to use a bit less than 80 for the textwidth most of the time, is there any recommendation for that?
 
* mua settings
 
* mua settings
   Is it possible in some user agents to reply automatically to all people in a thread and the mailing list, if so please post configuration options :)
+
   Is it possible in some user agents to reply automatically to all people in a thread and the mailing list? If so please post configuration options :)
 +
 
 +
= Random stuff =
 +
* Why is there always a Git-prefix to the wiki pages?
  
 
__NOTOC__
 
__NOTOC__

Revision as of 17:17, 25 June 2006

This page is for recording (or discussion) of Suggestions about the the [[FrontPage|GitWiki]] Web site.

Make sure your suggestion doesn’t exist already or that your question has already been answered by checking HelpContents.


Table of contents

<<(2)>>


Editing

Parsers

It would be nice to have installed parsers from [[MoinMoin:ParserMarket|ParserMarket]] (see [[MoinMoin:ParserMarket#head-17c33967bbb4345a453627b944bad1f1bc4b2791|Installation Instructions]] there) for languages used in Git, Cogito and examples, i.e for Perl, shell and e.g. diff.

InterWiki Links

It would be nice if there were shorter InterWiki links for linking to the Git and Cogito documentation, both HTML version and gitweb sources. One of the way of adding InterWiki link is to modify site's `data/intermap.txt` file.

For git and cogito manpages online it would mean that instead of writing for example

[http://www.kernel.org/pub/software/scm/git/docs/git-apply.html git-apply(1)]

(git-apply(1)) use (proposal) GitDoc InterWiki link, i.e. use one of the following (ones that are possible to create)

[wiki:GitDoc:git-apply git-apply(1)]
GitDoc:git-apply

if it is not possible). Analogous for Cogito docs.

For links to file in the git.git source via gitweb, instead of using for example

[http://www.kernel.org/git/?p=git/git.git;a=blob;hb=HEAD;f=Documentation/git-apply.txt git-apply.txt]

(git-apply.txt) use GitSource InterWiki link

[wiki:GitSource:Documentation/git-apply.txt git-apply.txt]

Would be also of use to have InterWiki links for common [[GitCommunity|GitMailingList]] archives, i.e. MARC and GMane, similarly like there is now MsgID InterWiki link?

New Pages

Here a few suggestions for new pages.

Best Practice Page

  • commit message: short summary (<80 characters and not the beginning sentence continuing in second line) \n\n long description
  Reason: emailed patches, oneline log, gitweb overview.
  Some tools currently insert new lines after the first line if there is none. This may be considered as a bug and should be fixed.
  • branching is easy and fast, use it (encourage topic branches)
  • rebase if you've been the only person working on the branch to prevent unnecessary merges (making the history complicated)

Development Page

  • common pitfalls
    • run make test after patching
    • check for correct whitespaces (tabs, no spaces for indentation, no space at eol)
  • editor settings
  vim:tabstop=8:softtabstop=8:shiftwidth=8:noexpandtab:textwidth=80 for C files
  documentation seems to use a bit less than 80 for the textwidth most of the time, is there any recommendation for that?
  • mua settings
  Is it possible in some user agents to reply automatically to all people in a thread and the mailing list? If so please post configuration options :)

Random stuff

  • Why is there always a Git-prefix to the wiki pages?


Personal tools