Adding contributing using browser to docs

This commit is contained in:
silversword411 2021-09-21 12:18:44 -04:00
parent 0d9a1dc5eb
commit d065adcd8e
4 changed files with 56 additions and 5 deletions

View File

@ -0,0 +1,51 @@
# Contributing Using Web Browser
## Getting Started
### 1. Fork Project in Github
This is making a duplicate of the code under your Github that you can edit
<https://github.com/wh1te909/tacticalrmm>
![ForkIt](images/vscode-forkit.png)
### 2. Make Edits
Make some changes
![Edit](images/contribute_browser_make_changes.png)
![Edit](images/contribute_browser_make_changes2.png)
### 3. Request your changes to be pulled into the primary repo (Pull Request)
![Changes you've made need integration with master repo](images/trmm_contribute-notice.png)
This is taking your changes and requesting they be integrated into the Tactical RMM develop branch.
#### 3a. Check the status of your PR
Look at a summary of the changes you've requested, monitor for them to be accepted, or commented on.
<https://github.com/wh1te909/tacticalrmm/pulls>
Once they're accepted you can either:
* Delete your fork
* Sync your local fork
#### 4. Sync your fork
<https://docs.github.com/en/github/collaborating-with-issues-and-pull-requests/syncing-a-fork>
Bring changes from original repo to your fork so you're current with changes made in original Github repo
![Sync Fork](images/trmm_need_sync_local_fork.png)
#### 5. Lather, Rinse, Repeat
Goto Step 2. and contribute some more
## Notes
After your changes are accepted, they won't be live in Tactical RMM until there is a new [release](https://github.com/wh1te909/tacticalrmm/releases). #BePatient

View File

@ -4,13 +4,13 @@
### 1. Install vscode
[https://code.visualstudio.com/download](https://code.visualstudio.com/download)
<https://code.visualstudio.com/download>
### 2. Fork Project in Github
This is making a duplicate of the code under your Github that you can edit
[https://github.com/wh1te909/tacticalrmm](https://github.com/wh1te909/tacticalrmm)
<https://github.com/wh1te909/tacticalrmm>
![ForkIt](images/vscode-forkit.png)
@ -30,7 +30,7 @@ Remote - SSH
### 4. Open Terminal
[https://code.visualstudio.com/docs/editor/integrated-terminal](https://code.visualstudio.com/docs/editor/integrated-terminal)
<https://code.visualstudio.com/docs/editor/integrated-terminal>
```text
Ctrl+`
@ -38,7 +38,7 @@ Ctrl+`
### 5. Configure a remote for your fork (in vscode)
[https://docs.github.com/en/github/collaborating-with-issues-and-pull-requests/configuring-a-remote-for-a-fork](https://docs.github.com/en/github/collaborating-with-issues-and-pull-requests/configuring-a-remote-for-a-fork)
<https://docs.github.com/en/github/collaborating-with-issues-and-pull-requests/configuring-a-remote-for-a-fork>
Configure your local fork and tell it where the original code repo is so you can compare and merge updates later when official repo is updated
@ -78,7 +78,7 @@ In browser create pull request
### 7. Sync your local fork
[https://docs.github.com/en/github/collaborating-with-issues-and-pull-requests/syncing-a-fork](https://docs.github.com/en/github/collaborating-with-issues-and-pull-requests/syncing-a-fork)
<https://docs.github.com/en/github/collaborating-with-issues-and-pull-requests/syncing-a-fork>
Bring changes from original repo to your local vscode copy so you're current with changes made in original Github repo

Binary file not shown.

After

Width:  |  Height:  |  Size: 47 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 19 KiB