Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

GitHub Workshop: Add research role terms to the Glossary #22

Open
BrainonSilicon opened this issue Oct 12, 2022 · 0 comments
Open

GitHub Workshop: Add research role terms to the Glossary #22

BrainonSilicon opened this issue Oct 12, 2022 · 0 comments
Assignees
Labels
collaboration-workshop Issues and teaks related to the Collaboration Workshop good first issue Good for newcomers new terms Suggestions of terms that should be added to the Glossary.

Comments

@BrainonSilicon
Copy link
Contributor

BrainonSilicon commented Oct 12, 2022

GitHub for Collaboration Workshop

This issue accompanies the GitHub for Collaboration Workshop developed by Eirini Zormpa, Sophia Batchelor and Rachael Stickland for the AIM RSF. We're so glad to have you here! 🎉

Below you'll find some instructions for how to contribute to the AIM RSF Glossary of Terms and develop collaborative practices on GitHub. If you have any questions, please let @RayStick or @eirini-zormpa know on Zoom so that we can assist you.

Summary

Terms that were identified and discussed during the September Collaboration Cafe need to be added to the Glossary of Terms.

Guide to Contribution

  1. Go to the glossary file in this repository to address the issue: https://github.com/aim-rsf/Glossary-of-Terms/blob/main/docs/terms/Research-Projects.md

  2. Click 'Edit this file'.

  3. Use Markdown format to add the following term and definition to the Glossary on line 6.


ECR
        Early Career Researcher. The term "ECR" refers to someone who is within eight years of their PhD award or equivalent professional training. There are many Early Career Researchers working on the AI for Multiple Long-Term Conditions research project.

Make sure that you also copy the white space and that the definition is inset from the term.

  1. Click 'Preview' to check that the changes look the way you'd like them too!

  2. Navigate to 'Propose changes' at the bottom of the page: edit the title and the description of the issue to describe your update to the community.

  3. Click 'Propose changes'. You will be redirected to a new page to make a Pull Request within the project.

  4. Fill in any relevant information, including the issue that the pull request fixes. You can connect the pull request and the issue it addressed using a#. You can find the issue number next to the title of this issue (this one is 22).

For example: this pull request fixes #22

Including this sentence in the body of your pull request will automagically close the issue once the pull request is merged 🪄✨

  1. Click 'Create Pull Request'! Congratulations! 🎉

  2. A reviewer will review your pull request, and ask you if you need to make any changes before it can be approved.

  3. There are a number of checks your project will undergo: to check for merge conflicts, inclusive language, and formatting issues. Wait until those checks are complete before merging.

  4. Once your pull request is approved and the checks are complete, you can merge your change into the repository! ✅

@BrainonSilicon BrainonSilicon added good first issue Good for newcomers collaboration-workshop Issues and teaks related to the Collaboration Workshop labels Oct 12, 2022
@RayStick RayStick self-assigned this Oct 17, 2022
@BrainonSilicon BrainonSilicon added the new terms Suggestions of terms that should be added to the Glossary. label Dec 7, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
collaboration-workshop Issues and teaks related to the Collaboration Workshop good first issue Good for newcomers new terms Suggestions of terms that should be added to the Glossary.
Projects
None yet
Development

No branches or pull requests

3 participants