|
| 1 | +--- |
| 2 | +layout: default |
| 3 | +title: 'Contributing to Documentation' |
| 4 | +categories: [blog] |
| 5 | +date: 2016-02-11 00:00:00 -0800 |
| 6 | +author: kathweaver |
| 7 | +download: true |
| 8 | +--- |
| 9 | + |
| 10 | +One of the best ways to contribute is testing. There are test plans and some |
| 11 | +information in the source, under the directory test plans. Also feel free to |
| 12 | +check those and update them if you find an issue. |
| 13 | + |
| 14 | +They are basically check lists that go through every function of the software and tell |
| 15 | +what should happen when you do them, including images. We came up with this on my last |
| 16 | +programming gig, and they helped everyone. |
| 17 | + |
| 18 | +The programmers then knew what we were expecting and so did QA. I often had QA help me with |
| 19 | +them so that they would have some ownership. |
| 20 | + |
| 21 | +So what do you test and how? |
| 22 | + |
| 23 | +Each time a developer makes a pull request, you should go through the new functionality |
| 24 | +and make sure it behaves as expected. Then you should go through the rest of the software |
| 25 | +making sure that something wasn't accidently broke. |
| 26 | + |
| 27 | +At least two different people should go through the process, but the more the better. It also |
| 28 | +helps if someone goes through it that has a fresh eye on the software. |
| 29 | + |
| 30 | +So where do you find the executeable? To do the last build in the pull request, |
| 31 | +scroll down to the point where you see "All checks have passed", and click on "Show All Checks". |
| 32 | +Click on "Details", then "Artifacts", and will see OpenLiveWriteSetup.exe -- download |
| 33 | +that and run it even if you get messages from Windows saying it isn't safe. |
| 34 | + |
| 35 | +If you do find an error, give the developer as much information as you can. Screenshots, error messages, |
| 36 | +log files, you name it. The more complete you are, the less time the developer has to spend tracking |
| 37 | +the error down. |
| 38 | + |
| 39 | +----- |
| 40 | + |
| 41 | +You can also test the nightly build. It will contain everything that has been merged. |
| 42 | + |
| 43 | +You can setup OpenLiveWriter to always run the nightly build: |
| 44 | +Go to regedit, find the registery key: HKEY_CURRENT_USER\SOFTWARE\OpenLiveWriter\Updates |
| 45 | +Then you need to create a dword key for CheckForBetaUpdates 1 = beta, 0 = regular. |
| 46 | + |
| 47 | +You can also pull the nightly build manually by going to this link: |
| 48 | +https://ci.appveyor.com/project/dotnetfoundation/openlivewriter/build/artifacts |
| 49 | + |
| 50 | +Or click on the build button from the readme and then click on latest build, artifacts |
| 51 | + |
| 52 | +Again, if you find a problem you'll need to raise an issue and give as much information as you can. |
0 commit comments