1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
|
---
title: Information about sending patches for review
x-toc-enable: true
...
Download TransChat from the Git repository like so:
git clone https://notabug.org/transchat/trans.chat.git
Git is a version control system, used to host the site, to coordinate
development. You can download and work on the entire website, using Git.
The Git software is available on Windows, MacOS, GNU+Linux, BSD and others. We
strongly recommend GNU+Linux or BSD, but Windows and Mac OS also work with
Git. Search on Google for basic information about how to use Git.
Some of the instructions here assume that you use GNU+Linux or BSD, so you will
have to adapt accordingly if you use something else. The core administrators
maintaining the website all use GNU+Linux.
You can submit your patches via
[Notabug pull requests](#how-to-submit-your-patches-via-pull-requests) or
Editing the website and documentation, wiki-style
-------------------------------------------------
The website and documentation is inside the `www` directory in the
[Git repository](#how-to-download-transchat-from-the-git-repository), in
Pandoc flavoured Markdown. The website is generated into static HTML via Pandoc
with the following scripts in that directory:
- index.sh: generates the news feed (on the News section of the website)
- publish.sh: converts an .md file to an .html file
- Makefile: with calls to index.sh and publish.sh, compiles the entire
TransChat website
Use any standard text editor (e.g. Vim, Emacs, Nano, Gedit) to edit the files,
commit the changes and
[send patches](#how-to-submit-your-patches-via-pull-requests).
Optionally, you can install a web server (e.g. lighttpd, nginx) locally and
set the document root to the *www* directory in your local Git repository.
With this configuration, you can then generate your local version of the
website and view it by typing `localhost` in your browser's URL bar.
Privacy of contributors (you do not have to reveal your name or identity!)
-------------------------------------------------------------------------
Contributions that you make are publicly recorded, in a Git repository which
everyone can access. This includes the name and email address of the
contributor.
In Git, for author name and email address, you do not have to use identifying
data. You can use TransChat Contributor and your email address could be
specified as contributor@transchat.org.uk. You are permitted to do this, if
you wish to maintain privacy.
Of course, you can use whichever name you like.
Legally speaking, all copyright is automatic under the Berne Convention of
international copyright law. It does not matter which name, or indeed whether
you even declare a copyright (but we do require that certain copyright
licenses are used - read more about that on this same page).
If you use a different name and email address on your commits/patches, then
you should be fairly anonymous.
General guidelines for submitting patches
-----------------------------------------
We require all patches to be submitted under a free license:
<https://www.gnu.org/licenses/license-list.html>.
- For documentation, we require GNU Free Documentation License v1.3 or higher. Basically, this is required on any Web pages that you contribute, or make changes to.
- GNU General Public License v3 is highly recommended, if you're contributing code (e.g. working on the static site generator that the site uses)
If you do not agree to use one of these licenses accordingly, your contribution will be rejected.
*Always* declare a license on your work! Not declaring a license means that
the default, restrictive copyright laws apply, which would make your work
non-free.
GNU+Linux is generally recommended as the OS of choice, for TransChat
development.
General code review guidelines
------------------------------
Any member of the public can
[submit a patch](#how-to-submit-your-patches-via-pull-requests).
Your patch will be reviewed for quality assurance, and merged if accepted.
How to download TransChat from the Git repository
-------------------------------------------------
In your terminal:
git clone https://notabug.org/transchat/trans.chat.git
A new directory named `transchat` will have been created, containing
transchat.
How to submit your patches (via pull requests)
----------------------------------------------
Make an account on <https://notabug.org/> and navigate (while logged in) to
<https://notabug.org/transchat/trans.chat>. Click *Fork* and in your account,
you will have your own repository of TransChat. Clone your repository, make
whatever changes you like to it and then push to your repository, in your
account on NotABug.
Now, navigate to <https://notabug.org/transchat/trans.chat/pulls> and click
*New Pull Request*.
You can submit your patches there. Alternative, you can log onto the TransChat
IRC channel and notify the channel of which patches you want reviewed, if you
have your own Git repository with the patches.
Once you have issued a Pull Request, the TransChat maintainers will be notified
via email. If you do not receive a fast enough response from the project, then
you could also notify the project via the `#transchat` channel on Libera.
|
