Update Documentation
- Dominant language
- HTML
- Stars
- 1
- Forks
- 1
- Avg merge
- 1h 53m
- Merged PRs (30d)
- 27
Description
# Description
This task is relatively simple. It requires you to look at the current documentation and fix any spelling mistakes or words/sentences that do not make sense.
# Tasks
* [ ] You will be looking at documentation, as well as interpreting the JavaScript/HTML if necessary.
* [ ] You will replace words/sentences that don't make sense or need updating due to feature changes.
* [ ] You will need to submit your changes in a pull request that documents what you changed.
# Steps
1. You will need to fork the repository to your GitHub account. To do this, press the **Fork** button on the repository's code page.
2. Clone your fork to your local machine. Make sure you have Git installed first; if not, please install it.
3. Once Git is installed, run the following command to clone the repository:
```dos
git clone https://github.com/your-username/satiscode.git
```
*(Replace `your-username` with your actual GitHub username.)*
4. Navigate into the repository directory and create a new branch for your work:
```dos
cd satiscode
git branch your-branch-name
git switch your-branch-name
```
*(Replace `your-branch-name` with a descriptive name for your branch.)*
5. Make your documentation changes in your editor.
6. Stage, commit, and push your changes to your fork:
```dos
git add .
git commit -m "Your commit message"
git push -u origin your-branch-name
```
> **Note:** If you get an error asking to configure `user.name` and `user.email`, run the following commands with your details before committing:
> ```dos
> git config --global user.name "your-github-username"
> git config --global user.email "you@your-email.com"
>
> ```
>
>
7. Go to the main repository at `https://github.com/gtref/satiscode` and submit a pull request from your fork.
After you complete this please in the same PR update the file CONTRIBUTORS.md with your details if you would like to be acknowledged
Contributor guide
Assessment
This issue has not been assessed yet.