commit 3d0e13aaf37a0050f6158a719803f248c6f2d933 Author: Nima Fatemi mrphs@riseup.net Date: Sat Nov 15 01:43:25 2014 +0000
Update README.md
Add how to contribute --- README.md | 30 ++++++++++++++++++++++++++++++ 1 file changed, 30 insertions(+)
diff --git a/README.md b/README.md index 7372063..0295897 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,33 @@ +# How to contribute + +Thanks for being interested to work on the website, I tried to make a simple how-to for you to quickly get you setup: + +__Step 1:__ Clone the git repo. + + git clone https://git.torproject.org/project/web/webwml.git + cd webwml + +__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: + + git remote add pick-a-name your-git-url + +_Example:_ + `git remote tpo-gh git@github.com:mrphs/tpo.git` + +__Step 2:__ Create and switch to a new branch. + +_In the following example, I've named my branch "docs" as I'm planning to work on the documentations._ + + git checkout -b docs + +__Step 3:__ Now you can start working on website and make changes. Once you're done, commit and push it to your public repo. + +_Example:_ + + git push tpo-gh docs + +__Step 4:__ Open a new ticket on [trac](https://trac.torproject.org) with a link to your shiny new repo/branch. + # Building website Torproject website is being built and published automatically. To quickly get set up and build website locally, simply follow these steps: