diff options
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 21 |
1 files changed, 10 insertions, 11 deletions
| @@ -2,7 +2,7 @@ | |||
| 2 | 2 | ||
| 3 | [](https://www.nuget.org/packages/wix) | 3 | [](https://www.nuget.org/packages/wix) |
| 4 | [](https://www.nuget.org/stats/packages/WiX?groupby=Version) | 4 | [](https://www.nuget.org/stats/packages/WiX?groupby=Version) |
| 5 | [](https://github.com/wixtoolset/wix/actions/workflows/build.yml?query=branch%3Adevelop) | 5 | [](https://github.com/wixtoolset/wix/actions/workflows/build.yml?query=branch%3Amain) |
| 6 | 6 | ||
| 7 | # WiX Toolset | 7 | # WiX Toolset |
| 8 | 8 | ||
| @@ -37,9 +37,9 @@ This repository contains the WiX Toolset codebase. | |||
| 37 | 37 | ||
| 38 | ##### Getting started: | 38 | ##### Getting started: |
| 39 | 39 | ||
| 40 | * Fork the WiX repository (https://github.com/wixtoolset/wix.git) | 40 | * [Fork the WiX repository](https://github.com/wixtoolset/wix/fork) |
| 41 | into a GitHub domain that you control | 41 | into your own GitHub repository |
| 42 | * Clone the WiX repository from your fork (git clone https://github.com/yourdomain/wix.git) | 42 | * Clone the WiX repository from your fork (`git clone https://github.com/yourdomain/wix.git`) |
| 43 | into the directory of your choice | 43 | into the directory of your choice |
| 44 | 44 | ||
| 45 | ##### To build the WiX toolset: | 45 | ##### To build the WiX toolset: |
| @@ -50,15 +50,14 @@ This repository contains the WiX Toolset codebase. | |||
| 50 | 50 | ||
| 51 | ##### Executing your newly built WiX toolset | 51 | ##### Executing your newly built WiX toolset |
| 52 | 52 | ||
| 53 | * `build\wix\Debug\publish\wix\wix --help` (Of course changing Debug to Release if you built in Release mode) | 53 | * `build\wix\Debug\publish\wix\wix --help` (Change `Debug` to `Release` if you built in release mode) |
| 54 | 54 | ||
| 55 | ##### Pull request expectations | 55 | ##### Pull request expectations |
| 56 | 56 | ||
| 57 | * Pick an outstanding WiX issue (or create one). Add a comment requesting that you be assigned to the issue. Wait for confirmation. | 57 | * Pick an [outstanding WiX issue](https://github.com/wixtoolset/issues/issues?q=is%3Aissue+is%3Aopen+label%3A%22up+for+grabs%22) (or [create a new one](https://github.com/wixtoolset/issues/issues/new/choose)). Add a comment requesting that you be assigned to the issue. Wait for confirmation. |
| 58 | * To create a PR fork a new branch from the develop branch | 58 | * To create a pull request, [fork a new branch](https://github.com/wixtoolset/wix/fork) from the `main` branch |
| 59 | * Make changes to effect whatever changed behaviour is required for the PR | 59 | * Make changes to effect whatever changed behavior is required for the pull request |
| 60 | * Push the changes to your repository origin as needed | 60 | * Push the changes to your repository origin as needed |
| 61 | * If there are multiple commits squash them down to one commit. | 61 | * If the `main` branch has changed since you created your branch, rebase to the latest updates. |
| 62 | * If the develop branch has changed since you created your new branch rebase to the current development branch. | ||
| 63 | * If needed (ie, you squashed or rebased), do a force push of your branch | 62 | * If needed (ie, you squashed or rebased), do a force push of your branch |
| 64 | * Create a PR with your branch against the WiX repository. | 63 | * Create a pull request with your branch against the WiX repository. |