Skip to content

Commit

Permalink
Re-Apply PR ChrisTitusTech#2472 but for 'CONTRIBUTING.md' File
Browse files Browse the repository at this point in the history
  • Loading branch information
og-mrk committed Aug 8, 2024
1 parent 1945fe2 commit b52175f
Showing 1 changed file with 17 additions and 6 deletions.
23 changes: 17 additions & 6 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -46,27 +46,31 @@
### Overview

``` mermaid
graph LR
%%{init: {"flowchart": {"curve": "cardinal"}} }%%
graph TD
  A[Fork Project] --> B[Clone Repository];
  B --> C[Create New Branch];
  C --> D[Make Changes];
  D --> G[Test Changes];
  G --> H{Tests Passed?};
  H -->|Yes| E[Commit Changes];
  E --> F[Push Branch];
  H -->|No| J[Fix Issues];
  J --> G;
  E --> F[Push Branch];
  F --> K[Create Pull Request];
  K --> L[Fill out PR template];
  J --> G;
classDef default stroke:#333,stroke-width:4px,font-size:12pt;
```
!!! info

This is a diagram to guide you through the process. It may vary depending on the type of change you're making.

### Fork the Repo
* Fork the WinUtil Repository [here](https://github.com/ChrisTitusTech/winutil) to create a copy that will be available in your repository list.

![Fork Image](assets/Fork-Button-Dark.png#only-dark)
![FOrk Image](assets/Fork-Button-Light.png#only-light)

![Fork Image](assets/Fork-Button-Light.png#only-light)

### Clone the Fork
!!! tip
Expand All @@ -89,15 +93,22 @@ graph LR
* `cd {path to the folder with the compile.ps1}`
* Run the following command to compile and run WinUtil:
* `.\Compile.ps1 -run`
* ![Compile](assets/Compile.png)

![Compile](assets/Compile.png)

* After seeing that your changes work properly, feel free to commit the changes to the repository and make a PR. For help on that, follow the documentation below.

### Committing the changes
* Before committing your changes, please discard changes made to the `winutil.ps1` file, like the following:
- ![Push Commit Image](assets/Discard-GHD.png)

![Push Commit Image](assets/Discard-GHD.png)

* Now, commit your changes once you are happy with the result.

![Commit Image](assets/Commit-GHD.png)

* Push the changes to upload them to your fork on github.com.

![Push Commit Image](assets/Push-Commit.png)

### Making a PR
Expand Down

0 comments on commit b52175f

Please sign in to comment.