How to Update a Bias Glossary
This page provides guidance on how to contribute updates to the Bias Glossary by using a Pull Request (PR) workflow. This process ensures that changes are reviewed and approved in a structured manner, maintaining the quality and accuracy of the glossary.
Contributing to the Bias Glossary involves a series of steps managed through GitHub's Pull Request workflow. This ensures that all contributions are reviewed for accuracy and relevance before they are merged. Here is an overview of the process:
Open a terminal and run the following command:
$ git clone https://github.com/MIT-LCP/the-bias-glossary.wiki.git
This command will create a directory called the-bias-glossary.wiki containing all the files for the wiki.
It's good practice to make changes on a new branch. For this example, let's name the branch input/pulse-oxymeter-bias:
$ git switch -c input/pulse-oxymeter-bias
Edit the wiki pages as needed. Make sure to test your changes locally to ensure they work as expected.
After making your changes, commit them to your branch:
$ git add .
$ git commit -m "Add bias information for pulse oxymeters"
Push the changes from your local branch to the remote repository on GitHub:
$ git push -u origin input/pulse-oxymeter-bias
Navigate to the repository on GitHub. GitHub will automatically detect the new branch and may display a prompt to create a pull request. If it doesn’t, you can manually go to the "Pull Requests" tab and hit "New pull request".
Select input/pulse-oxymeter-bias as the "compare" branch and ensure it's comparing against the main branch (often master or main).
Fill in the details of the pull request, explaining the changes you made. Then, submit the pull request. This notifies project maintainers to review the changes.
Once reviewed and merged, your changes will be incorporated into the main wiki repository.