CONTRIBUTING.md 1.15 KB
Newer Older
1
2
3
4
5
6
7
Contributing for Sympa documentation
====================================

How to contribute
-----------------

  * Unless otherwise specified, contents of this document are licensed under
Sympa authors's avatar
Sympa authors committed
8
    CC BY-SA (see [LICENSE](LICENSE.md) file).  You, as an author, have to
9
10
11
12
13
    agree to this license.

  * Submit your additions, changes or proofreadings to
    [development site for document](https://github.com/sympa-community/sympa-community.github.io) as issues or pull requests.

14
15
      * Note that, if you have bug fix or improvement of Sympa itself, you would be better to submit it to [development site for Sympa](https://github.com/sympa-community/sympa).

16
17
18
19
20
  * When you submit pull request at first time, please don't forget to include
    addition of your name to [AUTHORS](AUTHORS.md) file.

  * Markdown is recommended format for the texts.

IKEDA Soji's avatar
typo.    
IKEDA Soji committed
21
    If you are not familiar with Markdown, plain text is allowed: Anyone may
22
23
24
    reformat your work.  Other formats (OpenDocument, HTML, POD, ...)
    should be converted to Markdown.

IKEDA Soji's avatar
IKEDA Soji committed
25
26
Markdown guidelines
-------------------
27
28
29
30
31
32
33

  * Don't use tab character.

  * Don't use inline HTML.

  * Use GitHub-style table, if table is necessary.