|
| 1 | +--- |
| 2 | +description: >- |
| 3 | + If you need any help to get set up, ask @mikepsinn for help in the Discussions |
| 4 | + forum. I'd be happy to respond to any questions or have a video call with you. |
| 5 | +--- |
| 6 | + |
| 7 | +# 💻 How to Contribute to the Docs |
| 8 | + |
| 9 | +{% hint style="danger" %} |
| 10 | +Make sure to adhere to the [Writing Style Guide](style-guide.md) and always use [Grammarly](https://grammarly.com) when editing. |
| 11 | +{% endhint %} |
| 12 | + |
| 13 | +## Option 1: Edit or Comment On Gitbook |
| 14 | + |
| 15 | +This is the easiest option if you're not familiar with git.  |
| 16 | + |
| 17 | +1. Click this link to get access to the Githbook space [https://app.gitbook.com/invite/5VrxfXthJ6nareW3125z/p0fM9cYNQCjl8W9EvAlb](https://app.gitbook.com/invite/5VrxfXthJ6nareW3125z/p0fM9cYNQCjl8W9EvAlb) |
| 18 | +2. If you've already clicked the above link and have access, go here to edit or comment: [https://app.gitbook.com/o/5VrxfXthJ6nareW3125z/s/ALpB7mDyBf0ce3vSyslF](https://app.gitbook.com/o/5VrxfXthJ6nareW3125z/s/ALpB7mDyBf0ce3vSyslF/) |
| 19 | + |
| 20 | +### Commenting on Githubook |
| 21 | + |
| 22 | +1. Just click the speech bubble to the right of any text. More info here [https://docs.gitbook.com/collaboration/comments](https://docs.gitbook.com/collaboration/comments) |
| 23 | + |
| 24 | +### Editing On Gitbook |
| 25 | + |
| 26 | +1. Follow the instructions here to edit and submit a change request: [https://docs.gitbook.com/editing-content/editing-pages/change-requests#creating-a-change-request](https://docs.gitbook.com/editing-content/editing-pages/change-requests#creating-a-change-request) |
| 27 | + |
| 28 | +{% hint style="danger" %} |
| 29 | +Make sure to enter a descriptive subject when submitting changes. |
| 30 | +{% endhint %} |
| 31 | + |
| 32 | +## Option 2: Edit Locally |
| 33 | + |
| 34 | +This is a good option if you want to get familiar with git or need to contribute code. |
| 35 | + |
| 36 | +Every page is a [MarkDown](https://guides.github.com/features/mastering-markdown/) file, which is an easy-to-learn syntax extension to plain text that makes creating links, rendering images, and nice-looking formatting simple. |
| 37 | + |
| 38 | +### Fork the Repository |
| 39 | + |
| 40 | +1. [Go to cure-dao/draft-whitepaper](https://github.com/cure-dao/draft-whitepaper) |
| 41 | + |
| 42 | +2\. Click on Fork your own copy of cure-dao/draft-whitepaper to your account |
| 43 | + |
| 44 | + |
| 45 | + |
| 46 | +3\. Click on your personal account name |
| 47 | + |
| 48 | + |
| 49 | + |
| 50 | +### How to Edit and Submit Your Changes |
| 51 | + |
| 52 | +Here are some helpful tutorials: |
| 53 | + |
| 54 | +* [https://www.section.io/engineering-education/how-to-submit-your-first-article/](https://www.section.io/engineering-education/how-to-submit-your-first-article/) |
| 55 | +* [https://github.com/firstcontributions/first-contributions/blob/master/gui-tool-tutorials/github-windows-vs-code-tutorial.md](https://github.com/firstcontributions/first-contributions/blob/master/gui-tool-tutorials/github-windows-vs-code-tutorial.md) |
| 56 | +* [https://www.dataschool.io/how-to-contribute-on-github/](https://www.dataschool.io/how-to-contribute-on-github/) |
| 57 | + |
| 58 | +## Other Options |
| 59 | + |
| 60 | +### Editing Directly on GitHub |
| 61 | + |
| 62 | +**(recommended for beginners or small changes)** |
| 63 | + |
| 64 | +The fastest way is to edit directly on GitHub. |
| 65 | + |
| 66 | +Each page has an "Edit on Github" link to the right of the content. By clicking it you are taken to the GitHub sign-in page, where you can either log in or create an account. |
| 67 | + |
| 68 | +Once logged in, you'll be taken to the GitHub built-in text editor where you can make your edits directly. When you've completed your changes, you can add any specific details on what was changed create a new Pull Request to the repository. From there one of the maintainers will review your changes, and either merge them or request changes. |
| 69 | + |
| 70 | +Remember that after you click "Propose Changes", you must also click on "Create Pull Request" on the next page. |
| 71 | + |
| 72 | +The process is illustrated in this [visual walk-through](https://scribehow.com/shared/How\_to\_Write\_a\_Constitution\_In\_a\_Democratic\_Fashion\_\_XPpT\_GzCQC27ouEjEF2oXg). |
| 73 | + |
| 74 | +1. Contributors should attempt to adhere to the prevailing `MarkDown` style, language, and layout. |
| 75 | +2. Please adhere to the guidelines in the [Writing Style Guide](style-guide.md). |
| 76 | +3. **Commit messages should be as detailed as possible to describe the changes made.** |
| 77 | + |
| 78 | +### Editing in Online VS Code |
| 79 | + |
| 80 | +You can also instantly open anything in an online version of VSCode in either of the following ways: |
| 81 | + |
| 82 | +1. Click the `Fork` button to create your own copy of this repository. |
| 83 | +2. Press the `.` charcter while browsing YOUR FORKED repository or pull request on GitHub. |
| 84 | +3. Edit in VS Code |
| 85 | +4. Click the Branch icon on the left |
| 86 | +5. Click the plus next to modified files |
| 87 | +6. Add a commit description |
| 88 | +7. Click the checkmark to commit |
| 89 | +8. Click the sync button at the bottom to upload your changes |
| 90 | +9. Open YOUR FORKED repository on GitHub |
| 91 | +10. Click "Contribute" to make a pull request back to the main repo. |
| 92 | + |
0 commit comments