Skip to content

Commit

Permalink
add how-to-contribute
Browse files Browse the repository at this point in the history
  • Loading branch information
hayamiz committed Dec 14, 2009
1 parent 929d552 commit 7ba492a
Show file tree
Hide file tree
Showing 4 changed files with 94 additions and 9 deletions.
2 changes: 1 addition & 1 deletion doc/web/Makefile
@@ -1,7 +1,7 @@

RM ?= rm -f
PUBLISH := ./publish.rb
MARKDOWN_DOCS := index.text
MARKDOWN_DOCS := index.text how-to-contribute.text
HTML_DOCS := $(subst .text,.html,$(MARKDOWN_DOCS))
HTML_ASSETS := style.css images
CATALOGS := ja.po
Expand Down
49 changes: 49 additions & 0 deletions doc/web/how-to-contribute.text
@@ -0,0 +1,49 @@
# How to contribute to twittering-mode

## Code

Recommended way is to fork on [GitHub](http://github.com/hayamiz/twittering-mode). Visit there and click 'fork' button.

Of course you can clone the git repository in the ordinary way:

git clone git://github.com/hayamiz/twittering-mode.git

### How to create patches

We recommend to follow these steps:

1. Pull the master branch(`hayamiz/master` on [GitHub](http://github.com/hayamiz/twittering-mode)).
1. Create a *topic branch* and make some modifications.
1. Before sending a patch, *rebase* the topic branch to the master.
1. Now it's ready to *post* your patch. Send a [pull request](http://github.com/guides/pull-requests) on [GitHub](http://github.com/hayamiz/twittering-mode) (if you have forked) and write a mail to [twittering-mode ML](http://sourceforge.net/mail/?group_id=288615).

#### Topic branch

(now writing...)

#### Rebasing a topic branch

(now writing...)

#### Posting your patch

(now writing...)

## Communication

All your voices should be sent to [twittering-mode ML](http://sourceforge.net/mail/?group_id=288615).

### Bug reports

If you find some bugs in twittering-mode, please send a mail with detailed information to [twittering-mode ML](http://sourceforge.net/mail/?group_id=288615):

* Platform (Windows, Linux, Mac OS X, ...)
* Kind of Emacs and its version number (GNU Emacs, XEmacs, Carbon Emacs, ...): you can check it by `(emacs-version)<C-j>` on `*scratch*` buffer.
* What you *wanted* to do, what you *actually did*, and what *happened*.
* Any other information you think it's important.

If you have enough time, please try to reproduce the bug in a minimal environment. You can launch Emacs without loading any scripts by `emacs -Q`. This saves our time so much :)

### Feature requests and others

Join [twittering-mode ML](http://sourceforge.net/mail/?group_id=288615) and let's talk!
10 changes: 7 additions & 3 deletions doc/web/index.text
Expand Up @@ -13,7 +13,13 @@ timelines, tweet, mark posts as favorites and so on.

* will be available soon

## Contribute
## Getting involved

See [how to contribute](./how-to-contribute.html) for detailed information.

### Mailing lists

Join [twittering-mode ML](http://sourceforge.net/mail/?group_id=288615).

### Repository

Expand All @@ -23,8 +29,6 @@ You can clone the git repository:

Or fork on [GitHub](http://github.com/hayamiz/twittering-mode)

See [Developer's guideline](#)(will be available soon) for more information.

## See also

* [EmacsWiki: TwitteringMode](http://www.emacswiki.org/emacs/TwitteringMode)
42 changes: 37 additions & 5 deletions doc/web/style.css
Expand Up @@ -6,14 +6,14 @@
body {
background: #555;
font-family: Verdana, Arial, Helvetica, sans-serif;
font-size: 15pt;
line-height: 18pt;
font-size: 12pt;
line-height: 13pt;
color: #333333;;
}

li {
margin-left: 20pt;
padding: 3pt;
padding: 2pt 3pt 2pt 3pt;
}

p {
Expand Down Expand Up @@ -93,23 +93,55 @@ float: left;
text-align: justify;
}
.left h1 {
font-size: 26pt;
font-size: 24pt;
line-height: 32pt;
letter-spacing: -2pt;
padding : 10px 0 15px 0;
}
.left h2 {
color: #FF4800;
font-size: 24pt;
font-size: 22pt;
line-height: 22pt;
letter-spacing: -2pt;
font-weight: 100;
padding : 10px 0 15px 0;
}
.left h3 {
text-decoration: underline;
line-height: 20pt;
}

.left h4 {
line-height: 20pt;
border-left: 10px solid gray;
padding-left: 5px;
}

.left ul {
padding: 10px 0 10px 0;
}

.left ol {
padding: 10px 0 10px 0;
}

.left pre {
margin: 10px;
padding: 10px;
border: 1px solid gray;
border-left: none;
border-right: none;
background: AliceBlue;
}

.left code {
border: 1px solid lightgray;
background: wheat;
}

.left pre code {
border: none;
background: none;
}

.right {
Expand Down

0 comments on commit 7ba492a

Please sign in to comment.