stashapp/Stash-Docs
1
0
Fork 0
mirror of https://github.com/stashapp/Stash-Docs.git synced 2026-04-12 23:37:00 -05:00
Code Issues Packages Projects Releases Wiki Activity

Fix typos in CONTRIBUTING.md

Browse Source
This commit is contained in:
DogmaDragon
2025-11-21 21:20:36 +02:00
parent abec365324
commit b9497f0531
1 changed files with 8 additions and 8 deletions
Download Patch File Download Diff File Expand all files Collapse all files

16
CONTRIBUTING.md
View File

@@ -1,17 +1,17 @@
# Contributing
Pull requests are welcome. If you are unfamilair with MkDocs/Material for MkDocs sctructure, look through [their documentation](https://squidfunk.github.io/mkdocs-material) for general idea for how it's structured and handy references.
Pull requests are welcome. If you are unfamilair with MkDocs/Material for MkDocs structure, look through [their documentation](https://squidfunk.github.io/mkdocs-material) for general idea for how it's structured and handy references.
## Contributing from the site via edit button
1. At the top of every page you will find an edit button
2. Cliking on it will open GitHub where you will be met with a message about not being able to edit directly.
2. Clicking on it will open GitHub where you will be met with a message about not being able to edit directly.
3. Click `Fork this repository`.
4. You should see the text editor now.
5. Make the changes to the page you want and scroll to the bottom.
6. Add a short comment to explains your changes and click `Propose changes`.
6. Add a short comment to explain your changes and click `Propose changes`.
7. Next page might look complicated, but all you need to do next is click `Create pull request`.
8. Here you can adjust the title and/or add extra comment and then click `Create pull request`.
8. Here you can adjust the title and/or add an extra comment and then click `Create pull request`.
9. That's it!
## Contributing directly from the repository
@@ -19,9 +19,9 @@ Pull requests are welcome. If you are unfamilair with MkDocs/Material for MkDocs
1. Go to the `docs` folder.
2. Open any .md file and click 🖉 (or `E` on your keyboard) to start editing.
3. Make the changes to the page you want and scroll to the bottom.
4. Add a short comment to explains your changes and click `Propose changes`.
4. Add a short comment to explain your changes and click `Propose changes`.
5. Next page might look complicated, but all you need to do next is click `Create pull request`.
6. Here you can adjust the title and/or add extra comment and then click `Create pull request`.
6. Here you can adjust the title and/or add an extra comment and then click `Create pull request`.
7. That's it!
## Contributing from the forked repository
@@ -31,8 +31,8 @@ Pull requests are welcome. If you are unfamilair with MkDocs/Material for MkDocs
3. Go to the `docs` folder.
4. Open any .md file and click 🖉 (or `E` on your keyboard) to start editing.
5. Make the changes to the page you want and scroll to the bottom.
6. Add a short comment to explains your changes and select `Create a new branch for this commit and start a pull request.`. You can name the branch whatever you want or leave the default.
6. Add a short comment to explain your changes and select `Create a new branch for this commit and start a pull request.`. You can name the branch whatever you want or leave the default.
7. Click `Propose changes`.
8. Next page might look complicated, but all you need to do next is click `Create pull request`.
9. Here you can adjust the title and/or add extra comment and then click `Create pull request`.
9. Here you can adjust the title and/or add an extra comment and then click `Create pull request`.
10. That's it!