Latest revision as of 04:47, 4 April 2017

Note: Feel free to correct, expand, do anything which could make this better and clearer. ^_^

Note: If you have a different OS you may still find this helpful. While you may not need to install and set up any software the rest is pretty much universal.

Contributor Licensing Agreement

The very first thing you need to do is read and sign a Contributor Licensing Agreement and mail it to Denise. If you don't agree with its terms Dreamwidth won't be able to accept your code; if you've submitted code but Denise doesn't have your CLA your code can't be used. So read it, think it over, sign it, mail it then wait until you're told it's been received. Now you can get started.

What do you need and why?

Because you're on Windows, you have to use quite a number of tools to access and manage things so this part might seem a little daunting. The good news is that 1) you're used to being flexible and resourceful, right? 2) once you've got everything set up things will be much simpler and intuitive.

So what do you need?

You need a github.com account to be able to fetch and copy the Dreamwith code, find issues to work on, and publish your code so it can be integrated to Dreamwidth. This is both where all the Dreamwidth code comes from and where your own code will end up but you won't do much work on the site itself.
You need a Dreamhack to see what your changes will do on the site for real. Think of a Dreamhack as an online mirror of the Dreamwidth site which you can do whatever you want with.
You need PuTTY to connect github.com to your Dreamhack, to connect your Dreamhack to github.com, and manage your work. Think of PuTTY as your command center.
You need WinSCP to visualize your Dreamhack files and be able to open them in a text editor. Think of WinSCP as a Dreamhack Explorer.
You need a text editor to edit your files.

Create an account on GitHub

Go to GitHub and create your account.

On your GitHub account

You need to fork the Dreamwidth code onto your own account. Forking is like cloning and branching. It will copy the code and also label your copy as being a branch (a fork) of the original Dreamwidth code so that everybody knows the two are connected.

Dreamwidth is divided into two parts: an open-source part called 'dw-free', and a private part called 'dw-nonfree'. The private part is composed of elements which are specific to dreamwidth.org and can't be used on other sites (e.g. the logo) and external elements Dreamwidth is allowed to use on its own site but can't redistribute to other sites.

To fork the free part go to https://github.com/dreamwidth/dw-free and click on Fork on the upper right corner.

To fork the nonfree part go to to https://github.com/dreamwidth/dw-nonfree and do the same.

Get a Dreamhack

Apply for a Dreamhack by filling this form. You can pick anything as your username. The email address you choose is used to send you important info and alerts.

N.B. Some users like having a separate address for their dev work but it's entirely up to you!

Once you're done, you should get an email with your login username and a password. Don't lose it.

Install PuTTY

Download it at [1] and install it.

Run PuTTY. In the configuration window, enter "ssh-hack.dreamwidth.net" for the host name. Go to Connection/Data and enter the username/login given to you in the welcome e-mail. It should be something like dh-username.

Click on Open. If you get a pop-up message about a key, click Yes.

Enter the password given to you in the welcome email when asked. Note that characters aren't displayed and the cursor doesn't move. It's normal.

Change your password by typing:

passwd

Your default Dreamhack account is called 'system'. Set its password with this command:

$LJHOME/bin/upgrading/make_system.pl

Install WinSCP

Install it at [2]. During the installation, you may be asked about the mode you prefer: Commander and Explorer. Commander works like an FTP client: a partitioned window with your computer files on one side and the Dreamhack files on the other. Explorer works like Windows Explorer and only displays your Dreamhack files. Either mode is fine. Pick what you're most used to.

Use "ssh-hack.dreamwidth.net" for the host name. Enter your username and the password you typed when you did passwd on PuTTY. Click on Save then on Login.

Get a good text editor

While you can use Notepad, I recommend Notepad++ instead. It's free, simple and will make editing much easier.

Set things up

Further configuration steps

These are not mandatory but will certainly make your life easier.

Change some git settings

In PuTTY, I suggest going through all the steps mentioned in this section.

Give special abilities to your system account

Log in to your Dreamhack (http://www.USERNAME.hack.dreamwidth.net/) using system and your password for this account.

Go to http://www.USERNAME.hack.dreamwidth.net/admin/priv/. Click on 'payments' type 'system' in the User field then click on 'Make Changes'. The system account now has the ability (called 'privilege' or 'priv') to give paid time to any account.

Go to http://www.USERNAME.hack.dreamwidth.net/admin/pay. Type 'system' in the Edit user field and click on Go. Make your account a seed one.

Get rid of invite codes

In WinSCP, go to /dw/ext/local/etc/, and double-click on config.pl. Find $USE_ACCT_CODES = 1; and change 1 to 0. Save your file.

If you're concerned about spam, you may want to create a promo code instead. Go to http://www.USERNAME.hack.dreamwidth.net/admin/invites/promo?state=active and click on 'Create New'. Enter a code name and a number (you can edit the number later if you're about to run out of invites).

Customize PuTTY and Notepad++

See these articles for details: PuTTY, Notepad++.

Update your code

--> in PuTTY

Code is committed by developers all the time. You must always update your repositories before you do anything else.

Go to this article and follow the instructions given there.

Make sure to check for updates as the script occasionally changes.

N.B. To create a new file open WinSCP, right click into the correct folder (/bin here) then click on New/File.

Make changes to your Dreamhack

Find and claim issues

--> on github.com

Issues are listed at https://github.com/dreamwidth/dw-free/issues and https://github.com/dreamwidth/dw-nonfree/issues. You can use the search bar at the top to browse labels. Once you've found something you like comment on the issue to 'claim' it.

Create a branch stemming from develop

Important: in PuTTY, you can get explanations about bash commands using help COMMAND (e.g. help cd) and any git commands using git COMMAND -h (e.g git pull -h).

--> in PuTTY

Pick the correct repository:
- if you want to work in dw-free you need to be in ~/dw$. If you're not type cd $LJHOME.
- if you want to work in dw-nonfree you need to be in ~/dw/ext/dw-nonfree$. If you're not type cd $LJHOME/ext/dw-nonfree

Then make sure you're in the develop branch using the checkout command:

git checkout develop

Now you can create a new branch specifically dedicated to the issue you want to work on:

git branch BRANCH_NAME

N.B. Use the issue number and a short description as your branch name: bug #xxx/short-description

Switch to your new branch:

git checkout BRANCH_NAME

And that's it. Now you can start coding!

Work, work, work

--> in WinSCP and your text editor

In WinSCP right click to edit the file you want to work on.

Remember that the free part of the code is in ~/dw/* while the non-free part is in ~/dw/ext/dw-nonfree/*.

Site pages are either .bml or .tt files. You can find them in ~dw/htdocs/ and ~dw/views/. They may use .pm modules and widgets, found in ~dw/cgi-bin/LJ/ and ~dw/cgi-bin/DW/.

Text strings are in ~dw/htdocs/xxx.bml.text, ~dw/views/xxx.tt.text) or ~dw/bin/upgrading/en.dat.

For more specific searches, see this article on how to use rgrep and find.

Test your changes

--> on your Dreamhack

Go to your Dreamhack and test. Edit the files again in WinSCP if more changes are needed. Go through these steps again to test your new changes.

N.B. In some rare instances, your changes won't go live instantly on your hack and you may need to update your database first.

Mark your changes as ready to be committed

--> in PuTTY

Before being committed, work is moved to the index or staging area. Think of it as the "Ready? Steady?" before the "Go!". At this point nothing is definite and you can easily change things.

To add the changes you've made on a specific file:

git add FILE_NAME

To add all files which have been edited or deleted at once:

git add -u

To add all files which have been added, deleted or edited at once:

git add .

If you realize you need to do some more work, edit the files again and use add when you're done. It's that simple.

Commit your changes

--> in PuTTY

If you think you're done with your work at this point you can commit your changes:

git commit

This will open the nano editor so you can type a commit message. Unfortunately, nano isn't very easy to type into (you can't use the number pad for instance) so I advise you to type your commit message in your text editor then paste it in nano (right click in PuTTY to paste).

Here's an example of commit message:

Bug #123. Short subject

Fixes #123.

Patch description

Description can go on several short lines.

Hit Ctrl+X, 'y' then Enter to save your message.

If you you need to do some more work later you can update your commit:

git commit --amend

N.B. You can also do this if you need to edit your commit message.

If you want to pace yourself or be easily able to go back to a certain point in your work you can do successive commits instead of one big final one.

Publish your code

Push your code to your github.com repository

--> in PuTTY

You should only push your changes to your develop branch on github.com once you're happy with your patch as things are a bit harder to change at this point. Once you've finished your work use the push command and the branch name:

git push origin BRANCH_NAME

Request your code to be pulled into the original Dreamwidth repository

--> on github.com

Go to your profile page on GitHub. Select the Public Activity tab. Spot the line where it says you've created a new branch. Click on the branch name then on Compare and Pull Request. Once you've checked things over, click on Send Pull Request on the right side. Finally, comment on the pull request to say it 'fixes #xxx' where #xxx is the issue number.

N.B. If there's an unusual delay between the moment you pushed your branch and the moment it appears on GitHub, check the status page.

What now?

--> on github.com

You'll get a notification once your pull request has been merged into the original develop branch, and the issue will be closed if no more work is needed.

On your profile your request will be marked as merged.

That's it! You're done. Congratulations!

Help!

If something's wrong you can always ask for help at dw_dev_training or on the #dreamwidth-dev IRC channel.

Reading / References

To understand things better, I suggest reading the GitHub Workflow guide from github.com, relevant sections of Git - The Simple Guide, watching part of Git for Ages 4 and Up (Watch on YouTube or Download), and reading the first three chapters of Pro Git.

For lots of useful commands, see Git How To.

Other useful references:

@@ Line 1: / Line 1: @@
 {{Note|text=Feel free to correct, expand, do anything which could make this better and clearer. ^_^}}
+{{Note|text=If you have a different OS you may still find this helpful. While you may not need to install and set up any software the rest is pretty much universal.}}
 = Contributor Licensing Agreement =
-The very first thing you need to do is [[Contributor_Licensing_Agreement|read and sign your CLA]] and mail it to Denise. If you don't agree with its terms Dreamwidth won't be able to accept your code; if you've submitted code but Denise doesn't have your CLA your code can't be added. So read, think it over, sign, mail then wait until you're told it's been received. You can then get started.
+The very first thing you need to do is [[Contributor_Licensing_Agreement|read and sign a Contributor Licensing Agreement]] and mail it to Denise. If you don't agree with its terms Dreamwidth won't be able to accept your code; if you've submitted code but Denise doesn't have your CLA your code can't be used. So read it, think it over, sign it, mail it then wait until you're told it's been received. Now you can get started.
@@ Line 12: / Line 14: @@
 So what do you need?
-# You need a github.com account to be able to fetch the Dreamwith code, create your own copies of it, and upload your own changes. This is both where all the Dreamwidth code comes from and where your own code will end on but it's only a gateway: you can't do much on the site itself.
+# You need a github.com account to be able to fetch and copy the Dreamwith code, find issues to work on, and publish your code so it can be integrated to Dreamwidth. This is both where all the Dreamwidth code comes from and where your own code will end up but you won't do much work on the site itself.
-# You need a Dreamhack to see what your changes will do on the site for real. Think of a Dreamhack as an online mirror of the Dreamwidth site which you get to play with and modify.
+# You need a Dreamhack to see what your changes will do on the site for real. Think of a Dreamhack as an online mirror of the Dreamwidth site which you can do whatever you want with.
-# You need PuTTY to connect GitHub to your Dreamhack, to connect your Dreamhack to GitHub, and access and manage everything. In short, PuTTY is your true command center.
+# You need PuTTY to connect github.com to your Dreamhack, to connect your Dreamhack to github.com, and manage your work. Think of PuTTY as your command center.
-# You need WinSCP to visualize your Dreamhack files and be able to open them in a text editor. It's pretty much like Explorer for your Dreamhack.
+# You need WinSCP to visualize your Dreamhack files and be able to open them in a text editor. Think of WinSCP as a Dreamhack Explorer.
 # You need a text editor to edit your files.
-# You need a Bugzilla account to find and files bugs.
-Each section mentions where you need to do things so you won't get lost.
 == Create an account on GitHub ==
-Go to [http://www.github.com/ GitHub], click on 'sign up and pricing' and create a free account. I suggest you pick a username people are familiar with and the same username you'll have on your Bugzilla account.
+Go to [https://github.com/ GitHub] and create your account.
+== On your GitHub account ==
+You need to fork the Dreamwidth code onto your own account. Forking is like cloning and branching. It will copy the code and also label your copy as being a branch (a fork) of the original Dreamwidth code so that everybody knows the two are connected.
+Dreamwidth is divided into two parts: an open-source part called 'dw-free', and a private part called 'dw-nonfree'. The private part is composed of elements which are specific to dreamwidth.org and can't be used on other sites (e.g. the logo) and external elements Dreamwidth is allowed to use on its own site but can't redistribute to other sites.
+* To fork the free part go to https://github.com/dreamwidth/dw-free and click on Fork on the upper right corner.
+* To fork the nonfree part go to to https://github.com/dreamwidth/dw-nonfree and do the same.
 == Get a Dreamhack ==
-Apply for a Dreamhack by [http://hack.dreamwidth.net/apply.shtml filling this form]. The two important fields are 'your desired username' and 'your email address'. Your username is used to manage your Dreamhack and create the URL where your Dreamhack will be located at so you can pick anything. Your email address is used to send you a welcome e-mail which contains important information as well as various alerts. You can pick any of your existing email addresses or choose to create an email account entirely devoted to your development work.
+Apply for a Dreamhack by [http://hack.dreamwidth.net/apply.shtml filling this form]. You can pick anything as your username. The email address you choose is used to send you important info and alerts.
+: N.B. Some users like having a separate address for their dev work but it's entirely up to you!
-Once you're done, you should get an e-mail with your login username and a password. Don't lose it.
+Once you're done, you should get an email with your login username and a password. Don't lose it.
 == Install PuTTY ==
-* Download 'Windows installer for everything except PuTTYtel' .exe file at [http://www.chiark.greenend.org.uk/~sgtatham/putty/download.html PuTTY] and install it.
+* Download it at [http://www.chiark.greenend.org.uk/~sgtatham/putty/download.html] and install it.
-* Run PuTTY. In the configuration window, enter "hack.dreamwidth.net" for the host name. Go to Connection/Data and enter the username/login given to you in the welcome e-mail. It should be something like dh-username.
+* Run PuTTY. In the configuration window, enter "ssh-hack.dreamwidth.net" for the host name. Go to Connection/Data and enter the username/login given to you in the welcome e-mail. It should be something like dh-username.
 * Click on Open. If you get a pop-up message about a key, click Yes.
-* Enter the password given to you in the welcome e-mail when asked. Note that no characters are displayed and the cursor won't move. It's normal.
+* Enter the password given to you in the welcome email when asked. Note that characters aren't displayed and the cursor doesn't move. It's normal.
 * Change your password by typing:
@@ Line 53: / Line 64: @@
 == Install WinSCP ==
-* Install [http://winscp.net/eng/download.php WinSCP]. During the installation, you may be asked about the mode you prefer: Commander and Explorer. Commander works like an FTP client: a partitioned window with your computer files on one side and the Dreamhack files on the other. Explorer will only display your Dreamhack files and works like Windows's Explorer. Either mode is fine. Pick what you're most used to.
+* Install it at [http://winscp.net/eng/download.php]. During the installation, you may be asked about the mode you prefer: Commander and Explorer. Commander works like an FTP client: a partitioned window with your computer files on one side and the Dreamhack files on the other. Explorer works like Windows Explorer and only displays your Dreamhack files. Either mode is fine. Pick what you're most used to.
-* Use "hack.dreamwidth.net" for the host name. Enter your username and the password you typed when you did <code>passwd</code> on PuTTY. Click on Save then on Login.
+* Use "ssh-hack.dreamwidth.net" for the host name. Enter your username and the password you typed when you did <code>passwd</code> on PuTTY. Click on Save then on Login.
@@ Line 61: / Line 72: @@
 While you can use Notepad, I recommend [http://notepad-plus-plus.org/download/ Notepad++] instead. It's free, simple and will make editing much easier.
-== Create a Bugzilla account ==
-Simply [http://bugs.dwscoalition.org/createaccount.cgi click here]. Go to [http://bugs.dwscoalition.org/userprefs.cgi?tab=account Name and Password] and enter your name following this format: <code>Name [:username]</code> as per <dwuser>mark</dwuser>'s [http://dw-dev.dreamwidth.org/17146.html instructions.] 'Name' can be your real name, a nickname, your username again, etc. Pick what you're comfortable with.
 = Set things up =
-== On your GitHub account ==
-You need to fork the Dreamwidth code onto your own account. Forking is like cloning and branching. It will copy the code and also label your copy as being a branch (a fork) of the original Dreamwidth code so that everybody knows the two are connected.
-Dreamwidth is divided into two parts: an open-source part called 'dw-free', and a private part called 'dw-nonfree'. The private part is composed of elements which are specific to dreamwidth.org and can't be used on other sites (e.g. the logo) and external elements Dreamwidth is allowed to use on its own site but not redistribute to other sites.
-* To fork the free part go to https://github.com/dreamwidth/dw-free and click on Fork on the upper right corner.
-* To fork the nonfree part go to to https://github.com/dreamwidth/dw-nonfree and do the same.
-== On your Dreamhack ==
-Now you need to 'import' both of these onto your Dreamhack and link them to the original Dreamwidth repositories on GitHub so you can easily fetch updates.
-To do so, [[Moving_your_Dreamwidth_installation_to_use_Github#Stop_the_server_and_all_workers | follow all the steps from this point on until you start your server again]] (but skip the 'non-dreamhack users' section).
 == Further configuration steps ==
@@ Line 109: / Line 97: @@
 * In WinSCP, go to <code>/dw/ext/local/etc/</code>, and double-click on <code>config.pl</code>. Find <code>$USE_ACCT_CODES = 1;</code> and change 1 to <code>0</code>. Save your file.
-* In PuTTY, type this to make the changes go live on your Dreamhack:
-<syntaxhighlight lang="bash">$LJHOME/bin/upgrading/update-db.pl -r -p --innodb
-$LJHOME/bin/upgrading/update-db.pl -r --cluster=all --innodb
-$LJHOME/bin/upgrading/texttool.pl load</syntaxhighlight>
 * If you're concerned about spam, you may want to create a promo code instead. Go to http://www.USERNAME.hack.dreamwidth.net/admin/invites/promo?state=active and click on 'Create New'. Enter a code name and a number (you can edit the number later if you're about to run out of invites).
@@ Line 124: / Line 106: @@
-= Make sure things are up-to-date =
+= Update your code =
-Important: in PuTTY, you can get explanations about bash commands using <code>help COMMAND</code> (e.g. <code>help cd</code>) and any git commands using <code>git COMMAND -h</code> (e.g <code>git pull -h</code>).
-== Update your code ==
 <strong>--> in PuTTY</strong>
@@ Line 135: / Line 112: @@
 Code is committed by developers all the time. You must always update your repositories before you do anything else.
-* Go to [[Dev_Maintenance#dwu_-_Updating_the_repos | this article]] and enter all the code listed in the second, bigger section for both dw-free and dw-nonfree (but don't enter the lines starting with #).
+* Go to [[Dev_Maintenance#dwu_-_Updating_the_repos | this article]] and follow the instructions given there.
-* You can also create a script to make this process simpler as explained in the article.
-* Make sure to check for updates to see if the script has changed.
+* Make sure to check for updates as the script occasionally changes.
 : N.B. To create a new file open WinSCP, right click into the correct folder (<code>/bin</code> here) then click on New/File.
-== Update your database ==
+= Make changes to your Dreamhack =
-<strong>--> in PuTTY</strong>
+== Find and claim issues ==
-* We're already seen this once but here it is again:
+<strong>--> on github.com</strong>
-<syntaxhighlight lang="bash">$LJHOME/bin/upgrading/update-db.pl -r -p --innodb
+Issues are listed at https://github.com/dreamwidth/dw-free/issues and https://github.com/dreamwidth/dw-nonfree/issues. You can use the search bar at the top to browse labels.
-$LJHOME/bin/upgrading/update-db.pl -r --cluster=all --innodb
+Once you've found something you like comment on the issue to 'claim' it.
-$LJHOME/bin/upgrading/texttool.pl load</syntaxhighlight>
-* You can also create a script to make this process simpler: see [[Dev_Maintenance#dwdb_-_Updating_the_database | this article]].
+== Create a branch stemming from develop ==
+Important: in PuTTY, you can get explanations about bash commands using <code>help COMMAND</code> (e.g. <code>help cd</code>) and any git commands using <code>git COMMAND -h</code> (e.g <code>git pull -h</code>).
-= Make changes to your local code =
-== Find or file a bug ==
-<strong>--> in Bugzilla</strong>
-* To find: you can use [http://bugs.dwscoalition.org/userprefs.cgi?tab=saved-searches predefined searches] such as [http://bugs.dwscoalition.org/buglist.cgi?cmdtype=dorem&remaction=run&namedcmd=unassigned%20effort-minor&sharer_id=2 unassigned effort-minor].
-: Some of these bugs may not appear to be 'minor' to you. No worries. There are usually a few tiny bugs which only require small changed to be done on one of the site pages (text to edit; elements to move, remove, add or hide from certain categories of users, etc.).
-* To file: make sure it's not already been filed using [http://bugs.dwscoalition.org/query.cgi?format=specific simple search] or [http://bugs.dwscoalition.org/query.cgi?format=advanced advanced search] then [http://bugs.dwscoalition.org/enter_bug.cgi?product=Dreamwidth%20Development use this form] to file a new bug. Fill and edit the fields as needed.
-* To assign a bug to yourself, click on Take next to Assign To and set the status to IN_PROGRESS.
-== Create a local branch stemming from develop ==
 <strong>--> in PuTTY</strong>
@@ Line 184: / Line 142: @@
 <syntaxhighlight lang="bash">git checkout develop</syntaxhighlight>
-* Now you can create a new branch specifically dedicated to the bug you want to work on using the <code>branch</code> command.
+* Now you can create a new branch specifically dedicated to the issue you want to work on:
-<syntaxhighlight lang="bash">git branch BRANCHNAME</syntaxhighlight>
+<syntaxhighlight lang="bash">git branch BRANCH_NAME</syntaxhighlight>
-: N.B. It is best if you use the bug number and a short description as your branch name: <code>bug####/short_description</code>
+: N.B. Use the issue number and a short description as your branch name: <code>bug #xxx/short-description</code>
-* To switch to this branch, use the <code>checkout</code> command again:
+* Switch to your new branch:
-<syntaxhighlight lang="bash">git checkout BRANCHNAME</syntaxhighlight>
+<syntaxhighlight lang="bash">git checkout BRANCH_NAME</syntaxhighlight>
-* You can also create and switch to a branch at the same time using:
-<syntaxhighlight lang="bash">git checkout -b BRANCHNAME</syntaxhighlight>
-* Finally you can also create and switch to a branch and make sure it stems from develop using:
-<syntaxhighlight lang="bash">git checkout -b BRANCHNAME develop</syntaxhighlight>
 * And that's it. Now you can start coding!
 == Work, work, work ==
-<strong>--> in WinSCP and your editor</strong>
+<strong>--> in WinSCP and your text editor</strong>
 * In WinSCP right click to edit the file you want to work on.
@@ Line 213: / Line 162: @@
 * Remember that the free part of the code is in <code>~/dw/*</code> while the non-free part is in <code>~/dw/ext/dw-nonfree/*</code>.
-* If you're working on site pages, you're working on .bml files. These are in <code>~dw/htdocs/</code> or one of the subsequent folders. You'll see that their names correspond to the URLs of site pages. These files may use .pm modules/widgets which are in <code>~dw/cgi-bin/LJ/</code> or <code>~dw/cgi-bin/DW/</code>.
+* Site pages are either [[BML|.bml]] or [[TT|.tt]] files. You can find them in <code>~dw/htdocs/</code> and <code>~dw/views/</code>. They may use .pm modules and widgets, found in <code>~dw/cgi-bin/LJ/</code> and <code>~dw/cgi-bin/DW/</code>.
-* For text strings which are not in <code>~dw/htdocs/xxx.bml.text</code> files, see <code>~dw/bin/upgrading/en.dat</code>.
+* Text strings are in <code>~dw/htdocs/xxx.bml.text</code>, <code>~dw/views/xxx.tt.text</code>) or <code>~dw/bin/upgrading/en.dat</code>.
 * For more specific searches, see [[Dev_Finding_Things|this article]] on how to use <code>rgrep</code> and <code>find</code>.
@@ Line 222: / Line 171: @@
 == Test your changes ==
-<strong>--> in PuTTY</strong>
+<strong>--> on your Dreamhack</strong>
-* Stop your Dreamhack:
+Go to your Dreamhack and test. Edit the files again in WinSCP if more changes are needed. Go through these steps again to test your new changes.
-<syntaxhighlight lang="bash">stop-apache</syntaxhighlight>
-* [[#Update_your_database|Update your database]] (type <code>dwdb</code> instead if you've created a script for it).
-* Start your Dreamhack again:
-<syntaxhighlight lang="bash">start-apache</syntaxhighlight>
-<strong>--> on your Dreamhack</strong>
-* Go to your Dreamhack and test. Edit the files again in WinSCP if more changes are needed. Go through these steps again to test your new changes.
+: N.B. In some rare instances, your changes won't go live instantly on your hack and you may need to [[Dev_Maintenance#Update_your_database|update your database first]].
-== Mark your local changes as ready to be committed ==
+== Mark your changes as ready to be committed ==
 <strong>--> in PuTTY</strong>
-Before being committed, work is moved to a staging area. Think of it as the "Ready? Steady?" before the "Go!". At this point nothing is definite and you can easily change things.
+Before being committed, work is moved to the index or staging area. Think of it as the "Ready? Steady?" before the "Go!". At this point nothing is definite and you can easily change things.
-* You can add your changes to the staging ('pre-commit') area using the <code>add</code> command:
+* To add the changes you've made on a specific file:
-<syntaxhighlight lang="bash">git add FILENAME</syntaxhighlight>
+<syntaxhighlight lang="bash">git add FILE_NAME</syntaxhighlight>
-* To add all files which have been updated at once you can use:
+* To add all files which have been edited or deleted at once:
 <syntaxhighlight lang="bash">git add -u</syntaxhighlight>
-* To add all files which have been added or updated at once use this instead:
+* To add all files which have been added, deleted or edited at once:
 <syntaxhighlight lang="bash">git add .</syntaxhighlight>
-* If you realize you need to do some more work, edit files again and use <code>add</code> again when you're done. It's that simple.
+* If you realize you need to do some more work, edit the files again and use <code>add</code> when you're done. It's that simple.
-== Commit your changes locally ==
+== Commit your changes ==
 <strong>--> in PuTTY</strong>
-* If you think you're done with your work at this point you can commit your changes locally using the <code>commit</code> command:
+* If you think you're done with your work at this point you can commit your changes:
 <syntaxhighlight lang="bash">git commit</syntaxhighlight>
@@ Line 268: / Line 209: @@
 * This will open the nano editor so you can type a commit message. Unfortunately, nano isn't very easy to type into (you can't use the number pad for instance) so I advise you to type your commit message in your text editor then paste it in nano (right click in PuTTY to paste).
-* Here's an example of commit message (no blanks between lines, though):
+* Here's an example of commit message:
-Bug #123 - Subject
+<code>Bug #123. Short subject
-Bugzilla URL
+Fixes #123.
 Patch description
-Description can go on several short lines.
+Description can go on several short lines.</code>
-* Hit Ctrl+X, 'y' then enter to save your message.
+* Hit Ctrl+X, 'y' then Enter to save your message.
-* If you you need to do some more work later you can update your commit using <code>--amend</code>:
+* If you you need to do some more work later you can update your commit:
 <syntaxhighlight lang="bash">git commit --amend</syntaxhighlight>
@@ Line 288: / Line 229: @@
 * If you want to pace yourself or be easily able to go back to a certain point in your work you can do successive commits instead of one big final one.
+= Publish your code =
-= Go from local to global =
+== Push your code to your github.com repository ==
-== Push the changes to your github.com repository ==
 <strong>--> in PuTTY</strong>
-You should only push your local changes to your develop branch on github.com once you're happy with your patch as things are a bit harder to change at this point. Once you've finished your work use the <code>push</code> command and the branch name:
+You should only push your changes to your develop branch on github.com once you're happy with your patch as things are a bit harder to change at this point. Once you've finished your work use the <code>push</code> command and the branch name:
-<syntaxhighlight lang="bash">git push origin BRANCHNAME</syntaxhighlight>
+<syntaxhighlight lang="bash">git push origin BRANCH_NAME</syntaxhighlight>
-== Request your changes to be pulled into the real Dreamwidth repository ==
+== Request your code to be pulled into the original Dreamwidth repository ==
 <strong>--> on github.com</strong>
-Go to your profile page on GitHub. Select the Public Activity tab. Spot the line where it says you've created a new branch. Click on the branch name. Click on Compare to make sure things are how you want them to be. Once you've checked things over, click on Pull Request at the top.
+Go to your profile page on GitHub. Select the Public Activity tab. Spot the line where it says you've created a new branch. Click on the branch name then on Compare and Pull Request. Once you've checked things over, click on Send Pull Request on the right side.
+Finally, comment on the pull request to say it 'fixes #xxx' where #xxx is the issue number.
-: N.B. If there's a delay between the moment you pushed your branch and the moment it appears on GitHub, [https://status.github.com/ check its status page], wait and refresh. (^_^)
+: N.B. If there's an unusual delay between the moment you pushed your branch and the moment it appears on GitHub, [https://status.github.com/ check the status page].
 == What now? ==
-<strong>--> in Bugzilla</strong>
+<strong>--> on github.com</strong>
-* You can comment on the bug with a link to your pull request if you want. Once your changes have been accepted and pulled into the Dreamwidth code (i.e. merged into develop), you'll get a notification and the bug will be closed if no more work is needed.
+* You'll get a notification once your pull request has been merged into the original develop branch, and the issue will be closed if no more work is needed.
-<strong>--> on github.com</strong>
+* On your profile your request will be marked as merged.
-* On GitHub your request will be marked as merged on your profile page.
 * That's it! You're done. Congratulations!
-= Extra case: the release branch =
+= Help! =
-<strong>--> in PuTTY</strong>
-If you need to make urgent fixes after a code push, first create a copy of the release branch. Like so:
-<syntaxhighlight lang="bash">git checkout -b release-X.X dreamwidth/release-X.X</syntaxhighlight>
-:X-X is the number given to the release on the GitHub repo branch. Make sure it matches.
-Then follow the usual steps (edit, add, commit, push) and when you request your changes to be pulled on GitHub make sure to select the release branch as your base branch and your head branch.
-= Help! Troubleshooting tips =
-== My branch has commits from another user! ==
-<strong>--> in PuTTY</strong>
-If you realize once you've pushed your branch to github.com that you built it upon another pull request that has been merged since then and that your branch now has commits from another user, don't panic. If these commits don't affect yours, you can easily rebase your branch against develop as explained in [[#How_to_update_your_branch|this how to]]. The system will see that some of the commits on your branch have already been merged into develop and will skip them, thus leaving only your own unmerged commits on your branch. There, all clean! All you have to do is push your branch again.
-== Issues with text strings ==
-* As <dwuser>denise</dwuser> explained [http://dw-dev-training.dreamwidth.org/13233.html here], you need to delete old text strings and create new ones when you edit .text files or en.dat instead of simply editing the text. If the change isn't critical - the string doesn't need to be renamed or the text change is minor - it's better to notify the site copy team so that text can be changed locally and the original file left alone.
-* If text you've modified doesn't appear on the site after a code push, append <code>?uselang=debug</code> to the page URL to make sure it's using the right string. If it is and it still doesn't display after a while, comment on <dwcomm>dw_maintenance</dwcomm>.
-== Starting over ==
-If something's wrong you can:
-* delete your GitHub repositories on github.com: go to your repository, click on Admin then scroll down to 'Delete this repository'.
-* then [[Moving_your_Dreamwidth_installation_to_use_Github#Stop_the_server_and_all_workers | go through these steps again]].
-If something's *really* wrong you can also [[Dreamhack_Troubleshooting#I_want_to_wipe_my_install_and_start_over|rebuild you Dreamhack completely and start over from scratch]].
+If something's wrong you can always ask for help at <dwcomm>dw_dev_training</dwcomm> or on the #dreamwidth-dev [[:Category:IRC|IRC]] channel.
-= Going further / References =
+= Reading / References =
-To understand the workflow better, I suggest reading the 'workflow', 'add & commit', 'pushing changes' and 'branching' sections of [http://rogerdudler.github.com/git-guide/index.html Git - The Simple Guide] and watching the beginning of [http://www.youtube.com/watch?v=1ffBJ4sVUb4 Git for Ages 4 and Up].
+To understand things better, I suggest reading [http://guides.github.com/overviews/flow/ the GitHub Workflow guide from github.com], relevant sections of [http://rogerdudler.github.com/git-guide/index.html Git - The Simple Guide], watching part of <em>Git for Ages 4 and Up</em> ([http://www.youtube.com/watch?v=1ffBJ4sVUb4 Watch on YouTube] or [http://mirror.internode.on.net/pub/linux.conf.au/2013/mp4/Git_For_Ages_4_And_Up.mp4 Download]), and reading the first three chapters of [http://git-scm.com/book Pro Git].
-For lots of useful commands, see [[How-To_on_Git_for_Newbies|these how-tos]].
+For lots of useful commands, see [[Git How To]].
 Other useful references:
@@ Line 370: / Line 276: @@
 * [[Moving_your_Dreamwidth_installation_to_use_Github|Moving to GitHub]]
 * [[Dev_Maintenance|Development Maintenance]]
-* [[Draft:_Github_development_process|Github Development Process]]
 * [http://ss64.com/bash/ Bash commands]
 * [[Git_Getting_Started|Git: Getting Started]]
-* [http://git-scm.com/documentation Pro Git]
+* [http://git-scm.com/book Pro Git]
 * [http://git-scm.com/book/commands Pro Git - Index of Commands]
-* [http://git-scm.com/docs Pro Git - Reference]
+* [http://git-scm.com/docs Git Reference]
 [[Category:Dreamhack]]

Difference between revisions of "Newbie Guide: Getting Started on Windows"

Latest revision as of 04:47, 4 April 2017

Contents

Contributor Licensing Agreement

What do you need and why?

Create an account on GitHub

On your GitHub account

Get a Dreamhack

Install PuTTY

Install WinSCP

Get a good text editor

Set things up

Further configuration steps

Change some git settings

Give special abilities to your system account

Get rid of invite codes

Customize PuTTY and Notepad++

Update your code

Make changes to your Dreamhack

Find and claim issues

Create a branch stemming from develop

Work, work, work

Test your changes

Mark your changes as ready to be committed

Commit your changes

Publish your code

Push your code to your github.com repository

Request your code to be pulled into the original Dreamwidth repository

What now?

Help!

Reading / References

Navigation menu

Search