MEDLab/crypto-wake
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Added steps for making an edit to Contributing

Browse Source
This commit is contained in:
Nathan Schneider
2022-09-28 18:38:56 +00:00
parent 12e32a762f
commit 4b024d6008
1 changed files with 16 additions and 1 deletions
Download Patch File Download Diff File Expand all files Collapse all files

17
files/docs/about/contributing.md
View File

@ -19,4 +19,19 @@ Each entry should have the following sections:
* Introduction - A brief summary of the project, around one paragraph
* Lore - A history of the project, including an explanation of its demise
* Lessons - Distill lessons from the project
* Links - Provide useful links about the project, starting with the official "Website," "Wikipedia" page, and "Codebase," if applicable. Use Wayback Machine links for inactive (or likely to become inactive) websites.
* Links - Provide useful links about the project, starting with the official "Website," "Wikipedia" page, and "Codebase," if applicable. Provide at least one Wayback Machine link to the project's website during its heyday.
## Steps for making an edit
Crypto Wake is hosted on a repository in GitLab, and entries are written in a simple format called [Markdown](https://www.markdownguide.org/cheat-sheet). To contribute, use the following steps:
* Press "Contribute" on the top-right of the website, or go [here](https://cryptowake.medlab.host/)
* Log into GitLab. You can use various social logins, from Google to GitHub.
* Then press "Web IDE" on the main repository page. When prompted, press "Fork project." This will create a copy of the project on your account.
* On the left file listing, navigate to `files > docs > stories` to see a list of existing story pages. Choose a story page to edit or create a new one using the pop-up menu next to the `stories` folder.
* Make the changes you would like to see, in one file or multiple files.
* When you're finished, press the "Create commit..." button under the file listing on the left.
* Enter some text as a commit message that summarizes what you did.
* Choose "Create a new branch" and leave "Start a new merge request" checked, and press "Commit."
* Review the information on the next screen and, to proceed, press "Create merge request." This will submit the changes to us for review. Thank you!