Skip to content

Commit

Permalink
Spelling and Phrasing Updates
Browse files Browse the repository at this point in the history
  • Loading branch information
@breezy-codes
breezy-codes committed Oct 25, 2024
1 parent 865fcf1 commit b50468c
Show file tree
Hide file tree
Showing 4 changed files with 214 additions and 98 deletions.
58 changes: 29 additions & 29 deletions src/content/docs/products/splashkit/splashkit-website/Onboarding/01-setting-up.mdx
View file
Original file line number Diff line number Diff line change
@@ -1,79 +1,79 @@
---
title: Get Started with Splashkit.io
description: This is a step-by-step guide on how to get started within the SplashKit Starlight Repo.
description: This is a step-by-step guide on how to get started within the SplashKit Starlight repo.
sidebar:
label: Getting Started with Splashkit.io
order: 1
---

import { Tabs, TabItem } from "@astrojs/starlight/components";

## Get your Environment Set Up
## Get Your Environment Set Up

### Install necessary tools
### Install Necessary Tools

First things first, you'll need to install the necessary tools to get started working within Splashkit.io.
Head to the [Splashkit.io](https://splashkit.io/) website and follow the instructions for your specific
operating system to install splashkit. Then head to [Docker](https://docs.docker.com/engine/install/)
First things first, you'll need to install the necessary tools to get started working within SplashKit.io.
Head to the [SplashKit.io](https://splashkit.io/) website and follow the instructions for your specific
operating system to install SplashKit. Then, head to [Docker](https://docs.docker.com/engine/install/)
and install Docker for your specific operating system. Finally, in your code editor of choice, ensure
you have added the [Astro Extension](https://docs.astro.build/en/editor-setup/) to your editor.

### Fork the Splashkit.io Repo
### Fork the SplashKit.io Repo

To get started working within the Starlight.io you need to first head over to GitHub and make your
own fork of the [Splashkit Repo](https://github.com/thoth-tech/splashkit.io-starlight).
To get started working within the Starlight repo, you need to first head over to GitHub and make your
own fork of the [SplashKit Repo](https://github.com/thoth-tech/splashkit.io-starlight).

![splashkit repo](./images/starlightrepo.png)

Then select the fork button and create the fork:
Then, select the fork button and create the fork:

![splashkit fork](./images/splashkitfork.png)

### Steps to Clone the Repo

<Tabs syncKey="github-management">
<TabItem label="Via CLI">
Head into the terminal within your machine and run the following commands, make sure to swap USERNAME
with your own username:
Open a terminal on your machine and run the following commands, making sure to replace `USERNAME`
with your own GitHub username:

```shell
git clone https://github.com/USERNAME/splashkit.io-starlight.git
```

Then navigate into the directory:
Then, navigate into the directory:

```shell
cd splashkit.io-starlight
git remote add upstream https://github.com/thoth-tech/splashkit.io-starlight.git
```

Now you're all set up to start working on the Splashkit.io repo.
Now you're all set up to start working on the SplashKit.io repo.

</TabItem>
<TabItem label="Via vscode">
Open a new vscode window, and then open the command palette by pressing `cmd + shift + p`, then type
`git clone` and paste the URL of your forked repo.
<TabItem label="Via VSCode">
Open a new VSCode window, and then open the command palette by pressing `cmd + shift + p` (or `ctrl
+ shift + p` on Windows/Linux), then type `git clone` and paste the URL of your forked repo.

![splashkit repo](./images/gitclone.gif)

When prompted select the folder location you want to clone the repo into.
When prompted, select the folder location where you want to clone the repo.

![splashkit repo](./images/cloningrepo.png)

Once the repo is cloned, vscode will prompt you to open the repo folder location.
Once the repo is cloned, VSCode will prompt you to open the repo folder location.

![splashkit repo](./images/openrepo.png)

Now you're all set up to start working on the Splashkit.io repo in vscode.
Now you're all set up to start working on the SplashKit.io repo in VSCode.

</TabItem>
<TabItem label="Via GitHub Desktop">

Open up GitHub Desktop and click on the `File` tab in the top left corner, then select `Clone Repository`.
Open GitHub Desktop and click on the `File` tab in the top-left corner, then select `Clone Repository`.

![splashkit repo](./images/clonegitdesk.png)

Here you can either filter via your existing repositories or find the forked repo, or paste the URL
Here you can either filter via your existing repositories, find the forked repo, or paste the URL
of the forked repo.

![splashkit repo](./images/cloneurlgitdesk.png)
Expand All @@ -85,19 +85,19 @@ Once the repo is cloned, you can open the repo in your preferred code editor.

## Create Branches for Contributions

To start contributing to the Splashkit.io repo, you'll need to create a new branch for each contribution.
To start contributing to the SplashKit.io repo, you'll need to create a new branch for each contribution.

### Steps to Create a New Branch

<Tabs syncKey="github-management">
<TabItem label="Via CLI">
Move into the Splashkit.io directory and create a new branch:
Move into the SplashKit.io directory and create a new branch:

```shell
git checkout -b your-branch-name
```

Then push the branch to your fork:
Then, push the branch to your fork:

```shell
git push origin your-branch-name
Expand All @@ -106,14 +106,14 @@ git push origin your-branch-name
Now you're all set up to start working on your new branch.

</TabItem>
<TabItem label="Via vscode">
<TabItem label="Via VSCode">

Open source control by clicking on the icon on the left-hand side of the vscode window. Then select
on the three dots, go down to branch and select `Create Branch from`.
Open source control by clicking on the icon on the left-hand side of the VSCode window. Then click
on the three dots, go down to `Branch`, and select `Create Branch from`.

![splashkit repo](./images/newbranch-vscode.png)

Then select to make the new branch from `master` and name your branch.
Then, select to make the new branch from `master` and name your branch.

![splashkit repo](./images/addbranch-vscode.png)
![splashkit repo](./images/namebranch-vscode.png)
Expand Down
145 changes: 108 additions & 37 deletions ...content/docs/products/splashkit/splashkit-website/Onboarding/03-pull-request.md
View file
Original file line number Diff line number Diff line change
@@ -1,102 +1,173 @@
---
title: How to Create a Pull Request
description: This is a step-by-step guide on how to create a pull request for SplashKit tutorials.
description: This is a step-by-step guide on how to create a pull request for SplashKit.
sidebar:
label: Pull Request Guide
order: 3
---

## How to Create a Pull Request

Follow these steps to create a pull request for the SplashKit tutorials repository.
This guide provides a step-by-step process for creating a pull request (PR) in the SplashKit Starlight
repository, PRs are the primary way to contribute changes to the project. By following these steps,
you can submit your own PRs and collaborate with other team members effectively.

### 1. Check for Upstream Branches

First, check if the upstream branches are already added to your local repository.
Before creating a pull request, it's important to ensure that your local repository is connected to
the correct upstream repository. The upstream repository is the original repository from which your
fork was created. You need this connection to pull in the latest changes from the main project.

To check if upstream branches are already linked to your local repository, run the following command:

```shell
git remote -v
```

This will display a list of remote repositories linked to your local repository. If the `upstream`
branch is not listed, you will need to add it in the next step.

### 2. Add Upstream Branches (if not present)

If the upstream branches are not added, you can add them using the following command. Replace
`<repo-name>` with the actual repository name.
If the upstream branch is not already added, you can manually add it to your local repository. This
ensures you can fetch and merge changes from the main repository whenever necessary.

To add the upstream branch, run the following command, replacing `<repo-name>` with the actual name
of the repository you're working with (e.g., `splashkit.io-starlight`).

```shell
git remote add upstream https://github.com/thoth-tech/<repo-name>.git
```

#### Example with `splashkit.io-starlight` Repository

For the `splashkit.io-starlight` repository, the command will look like this:

```shell
git remote add upstream https://github.com/thoth-tech/splashkit.io-starlight.git
```

### 3. Verify Upstream Branches

Verify that the upstream branches have been added successfully.
After adding the upstream branch, verify that it has been added correctly by running the following
command again:

```shell
git remote -v
```

You should see something like this:

```shell
origin https://github.com/YOUR-USERNAME/splashkit.io-starlight.git (fetch)
origin https://github.com/YOUR-USERNAME/splashkit.io-starlight.git (push)
upstream https://github.com/thoth-tech/splashkit.io-starlight.git (fetch)
upstream https://github.com/thoth-tech/splashkit.io-starlight.git (push)
```

If the upstream branch is correctly listed, you are now ready to create your pull request.

## Sync Your Fork (Optional but Recommended)

Before creating a pull request, it's good practice to sync your local fork with the upstream
repository to ensure you're working with the latest version. Run the following commands to fetch
and merge the latest changes from the upstream repository:

```shell
git fetch upstream
git checkout main
git merge upstream/main
```

This ensures that your pull request will not conflict with the latest updates made by others.

## Creating a Pull Request

To create a pull request, there are a few options available. You can use the GitHub website or the
[GitHub Pull Requests](https://marketplace.visualstudio.com/items?itemName=GitHub.vscode-pull-request-github)
extension in vscode.
There are two primary ways to create a pull request: using the GitHub website or the GitHub
Pull Requests extension in VSCode.

### Using GitHub Website
### Using the GitHub Website

#### 1. Open GitHub to Review the Pull Request

Open GitHub and navigate to the repository where you want to create a pull request. Click on the
"Pull requests" tab and then click on the "New pull request" button.
Head to GitHub and navigate to your forked repository. Once there, click on the **Pull requests**
tab at the top of the page, and then click the **New pull request** button.

![pull request](./images/pull-request-fig1.png)

#### 2. Change to the Correct Repository
#### 2. Select the Correct Repository and Branches

Next, make sure you're comparing the correct branches:

To ensure your pull request is directed to the correct repository, change the settings at the top of
the page.
- **Base Repository**: This should be set to `thoth-tech/splashkit.io-starlight` (the original
- repository you're contributing to).
- **Base Branch**: Select `main` as the branch to merge into.

- **Base Repository**: Set this to `thoth-tech/splashkit.io-starlight`.
- **Base Branch**: Set this to `main`.
The other dropdown should show your forked repository and the branch you want to merge from.

![pull request](./images/pull-request-fig2.png)

![pull request](./images/pull-request-fig3.png)
Ensure these settings are correct to avoid submitting changes to the wrong branch or repository.

#### 3. Review Your Changes

GitHub will display a comparison of the changes between your branch and the `main` branch of the
upstream repository. This is your opportunity to double-check the modifications you're proposing to merge.

#### 3. Add Pull Request Template
Make sure everything looks correct before proceeding.

Use the pull request template to provide detailed information about your request. Make sure to fill
out all necessary fields and complete any required checks.
#### 4. Add Pull Request Details

When you create a pull request, you'll need to provide some additional information using a pull
request template. This helps reviewers understand the context of your changes. Make sure to:

- Provide a clear and descriptive title for your pull request.
- Fill out the required fields in the template, such as the purpose of the changes, testing steps,
and any additional notes.

![pull request](./images/pull-request-fig4.png)

#### 4. Submit Your Pull Request
Be as detailed as possible. This makes it easier for reviewers to understand your contribution and
provide feedback.

#### 5. Submit the Pull Request

After filling out the template and completing all required checks, submit your pull request for
review.
Once you've filled out the template and confirmed your changes, click the **Create pull request**
button. Your pull request will now be submitted and visible to the repository maintainers and
reviewers for feedback.

### Using GitHub Pull Requests Extension in vscode
### Using the GitHub Pull Requests Extension in VSCode

The steps here remain mostly the same as the prior steps, but you can do it all within vscode.
Head to the extension within the sidebar and click on the `Create Pull Request` button. This will
give you the option to select the branch you want to create the pull request from and the branch
you want to merge into. Follow the same steps as above to fill out the template and submit the pull
request.
Alternatively, you can use the [GitHub Pull Requests extension](https://marketplace.visualstudio.com/items?itemName=GitHub.vscode-pull-request-github)
for VSCode. This allows you to create pull requests directly from your code editor.

#### 1. Open the Extension

In VSCode, click on the GitHub Pull Requests icon in the sidebar. If you don't see it, you can
install it from the Extensions Marketplace.

#### 2. Create the Pull Request

Click the **Create Pull Request** button, which will give you the option to select the branch
you want to merge from (your working branch) and the branch you want to merge into (usually `main`).

Follow the same steps as on the GitHub website to review your changes, fill out the pull request
template, and submit it.

![pull request](./images/prinvscode.gif)

### Next Steps
## Next Steps After Submitting a Pull Request

Once your pull request is submitted, move the associated Planner card to the **First Peer Review**
column in your project management tool, and share both the pull request and the Planner card
with your team or peer reviewers. Follow the information on the[Planner Board Ettiquette](/products/splashkit/splashkit-website/onboarding/07-planner-board)
page to ensure a smooth review process.

Keep an eye out for feedback from the reviewer, and be prepared to make changes if necessary.

Once the pull request is submitted, move the associated Planner card to the "First Peer Review" column
and share the pull request and card in the group chat. well done! Now, keep an eye out for feedback
from your peer reviewer.
### Useful Links

- [Pull Request Template](/products/splashkit/splashkit-website/onboarding/04-pull-request-template):
The template for creating a pull request for SplashKit tutorials.
- [Peer Review Guide](/products/splashkit/splashkit-website/onboarding/05-peer-review): The guide
on how to do a peer review within the SplashKit tutorials team.
The template for creating a pull request for SplashKit team.
- [Peer Review Guide](/products/splashkit/splashkit-website/onboarding/05-peer-review):
The guide on how to perform a peer review within the SplashKit team.
2 changes: 1 addition & 1 deletion ...ocs/products/splashkit/splashkit-website/Onboarding/04-pull-request-template.md
View file
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: Pull Request Template
description: This is a template for creating a pull request for SplashKit tutorials.
description: This is a template for creating a pull request for SplashKit Website.
sidebar:
label: Pull Request Template
order: 4
Expand Down
Loading

0 comments on commit b50468c

Please sign in to comment.