...
|
...
|
@@ -1,3 +1,33 @@
|
|
1
|
+# How to contribute
|
|
2
|
+
|
|
3
|
+Thanks for being interested to work on the website, I tried to make a simple how-to for you to quickly get you setup:
|
|
4
|
+
|
|
5
|
+__Step 1:__ Clone the git repo.
|
|
6
|
+
|
|
7
|
+ git clone https://git.torproject.org/project/web/webwml.git
|
|
8
|
+ cd webwml
|
|
9
|
+
|
|
10
|
+__Step 1b:__ Create a bare public repository (i.e on Github), where you'd push your commits to. Make sure you're in `webwml` directory, and run:
|
|
11
|
+
|
|
12
|
+ git remote add pick-a-name your-git-url
|
|
13
|
+
|
|
14
|
+_Example:_
|
|
15
|
+ `git remote tpo-gh git@github.com:mrphs/tpo.git`
|
|
16
|
+
|
|
17
|
+__Step 2:__ Create and switch to a new branch.
|
|
18
|
+
|
|
19
|
+_In the following example, I've named my branch "docs" as I'm planning to work on the documentations._
|
|
20
|
+
|
|
21
|
+ git checkout -b docs
|
|
22
|
+
|
|
23
|
+__Step 3:__ Now you can start working on website and make changes. Once you're done, commit and push it to your public repo.
|
|
24
|
+
|
|
25
|
+_Example:_
|
|
26
|
+
|
|
27
|
+ git push tpo-gh docs
|
|
28
|
+
|
|
29
|
+__Step 4:__ Open a new ticket on [trac](https://trac.torproject.org) with a link to your shiny new repo/branch.
|
|
30
|
+
|
1
|
31
|
# Building website
|
2
|
32
|
Torproject website is being built and published automatically.
|
3
|
33
|
To quickly get set up and build website locally, simply follow these steps:
|