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

update vi-create-issues-and-pull-requests.md #3531

Open
wants to merge 3 commits into
base: master
Choose a base branch
from

Conversation

Avinash-Codes
Copy link
Member

@Avinash-Codes Avinash-Codes commented Dec 25, 2024

Important: Do not tick a checkbox if you haven’t performed its action.

Before Creating the Pull Request

  • Verify the changes are on a new branch other than master – it should say "compare: branch-name".
  • Start the pull request title with lowercase letters, e.g., add githubusername.md.
  • Add issue number to the end of the pull request title when applicable, e.g., update mi-faq.md (fixes #3264).

After Creating the Pull Request

  • Go to "Commits" tab, make sure the commit username is clickable and linked to your GitHub account correctly.
  • Review the "Files changed" tab to ensure there are no unnecessary files or changes included in the pull request.
  • Verify that the raw.githack preview link is included in the description.
  • Preview the MDwiki rendered changes using the raw.githack link. Ensure it displays as expected without any errors.
  • Drop a link to this pull request in our discord channel.

Description, Screenshots and/or Screencast

fixes #

Raw.Githack Preview Link

https://raw.githack.com/open-learning-exchange/open-learning-exchange.github.io/adding-step-to-add-html-games/index.html#!pages/vi/vi-create-issues-and-pull-requests.md

@Avinash-Codes Avinash-Codes requested a review from dogi December 25, 2024 16:43
Copy link
Member

@jessewashburn jessewashburn left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

These instructions are very clear. I'm not sure this is the right place for them, as this section is about creating issues and pull requests.

@xyb994
Copy link
Member

xyb994 commented Jan 4, 2025

These instructions are very clear. I'm not sure this is the right place for them, as this section is about creating issues and pull requests.

This did come across my mind. Perhaps we could move this addition to a separate page under vi so we can link to it as one of the required issue/pr similar to asking vi working on the manual?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants