Update updates.md
[ccm-docs.git] / docs / pull_request.md
blobd62e2fa6e069dc6b01bffae46cc4fb6730597f0b
1 # How to edit
3 Please submit a pull request to CCM:
5 1. Fork [the Github repository](https://github.com/ccmucdenver/ccm-docs) (the "Fork" button in the upper right corner of the repository screen).
6 2. Clone your fork on your computer (green button "Code" in your forked repository).
7 3. Make a new branch off the main branch.
8 4. [open a pull request](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests) on github asking to merge your new branch into main. 
9 5. Make your changes following the MkDocs [Getting Started](https://www.mkdocs.org/getting-started) instructions how to build and preview the site on your computer, and [Writing your docs](https://www.mkdocs.org/user-guide/writing-your-docs) how to edit the pages.
10 6. Commit and push your changes to your pull request branch. It is OK to do that frequently.
11 7. When you are done, 
12     * merge the current main branch from the [Github repository](https://github.com/ccmucdenver/ccm-docs) into your pull request branch in your forked repository,
13     * resolve any merge conflicts and commit and push.
14     * preview and check around all places you changed that nothing went wrong, 
15     * repeat as needed until all looks to your satisfaction.
16 8. Let @janmandel know by a pull request comment that your pull request is ready to be merged.