Contributing

Welcome to the contribution guide!

Pre-contribution checklist

• You’ll need a Github account before you can contribute to the wiki.
• If you want to make more than a few contributions, please email David Lewis about joining the wiki contributors team and provide your github username.

Contributing to the Wiki

The wiki uses Markdown, a very simple markup language designed to make editing as easy as possible. See Markdown for more details.

Editing an Existing Page

If you only want to edit an existing page, simply hit the button at the bottom of the page. This will take you to a Github page corresponding to the current file.

Creating a new page

Navigate to the Github repository and hit the “add file” button. Add the path to your new page at the top of the window in this format: path/to/my/file.md.

Wiki Contributors team guidelines

• For small changes like typos, you may bypass the branch protections and commit your changes directly to the main branch.
• For large changes, please use the “create a new branch” setting when committing your changes. This way, someone can review your changes before adding them to the wiki.

Contributing while not being a member

When trying to commit changes, you will be prompted by Github to “fork this repository”. Once you do that, you can freely make as many changes as you want to your own copy of the wiki. Once you are satisfied with your changes, you can create a pull request using the Pull Requests tab of the Github repository for the wiki. If you need help, contact David Lewis

Sensitive Data guidelines

• Microsoft onedrive/teams links that contain sensitive data are fine (only accessible by CCHMC/UC org)
• Links to private repos in the BMI-UC org are fine (only accessible to members of the BMI-UC github org)

Issues and Discussions

• If there is a technical issue with the wiki, file an issue on the issues tab
• If you are interested in discussing the organzation/goals for the wiki, or just have an idea, please post it to the discussions tab

Extra Git help

• This wiki is stored in a git repository
• The git repository is stored on github
• When the main branch recieves commits, a github action is triggered, generating the website
• For more information about git, see David’s talk.