Skip to content

Latest commit

 

History

History
48 lines (30 loc) · 4.22 KB

vi-create-issues-and-pull-requests.md

File metadata and controls

48 lines (30 loc) · 4.22 KB

Create More Issues and Pull Requests (Step 8)

Estimated Time: 4.5h

Objectives

  • Create three more issues
  • Add comments to three other issues
  • Resolving three issues

Introduction

Just as your learning with this Wiki was made possible by the efforts of previous interns, now we turn to you to continue that tradition and help future interns take their First Steps. Through this step, you should try to further improve our Markdown Wiki, with better explanations, formatting fixes, and more! You must have made your pull requests and have them each approved by at least two other OLE team members/interns in order for it to be merged to the upstream repository. Just as before, announce your Pull Request on the Discord channel so other members can review it. You may need to make some additional corrections. Learn by teaching - or editing our teaching tool, in this case!

ToDo

In this step, your goal is to create, comment on, and resolve GitHub issues to improve our Markdown Wiki. Here's what you'll need to do:

  1. Create Issues:
  • Create 3 new issues in our GitHub repository regarding Software Engineering Virtual Intern First Steps's content or Planet User Manual.
  • Each issue should focus on a specific problem or improvement.
    • Ensure that at least one issue addresses content reduction, such as dead links, repetitive content, excessive detail, or the potential to reference external official documentation in Virtual Intern First Steps.
    • Ensure that at least one issue is about populating or improving the Planet User Manual page.

  1. Comment on Issues: Provide helpful comments on at least 3 existing issues that you did not create. This could be to provide feedback, suggest solutions, ask questions, or clarify the issue.

  2. Resolve Issues with Pull Requests: Resolve the 3 issues by making the necessary changes in separate branches derived from master in your repository, and submit a distinct pull request for each one.

Follow the same process as described in the GitHub Issues Tutorial step, working to improve our documentation for future interns. To get your pull requests merged, they must be approved by at least two other OLE team members/interns. After creating a pull request, announce it on the Discord chat to request reviews. You may need to make additional corrections based on feedback.

You are encouraged to post as many issues as you can for improving the page as well as for personal practice. Remember, even small issues are worth addressing and it is OK if you are not sure how to fix it yourself. If you know how to solve an issue, be sure to provide a detailed account of your research and show how to fix it. It is ok to file an issue about minor typos and very small grammar changes, but do not make this the case for all of the issues that you file.

NOTE: While adding details can be helpful, it's important to remember that less is often more. Over time, this First Steps guide has become bloated with too much information, making it harder to follow. As you work on improving this guide, focus on simplifying the instructions and removing any unnecessary content. The goal is to create a clear and concise guide that future virtual interns can easily understand and use.

HINT: While waiting for two OLE team members to approve your Pull Requests, you can continue creating more Issues and Pull Requests (upon approval, we suggest). They will all count towards your final Issue/PR total. PR approval can take time, so don't let a lengthy approval/fix process stop you from progressing in your "First Steps".

Track Your Progress

  • After completing Step 8, you should have:
    • 5 merged pull requests (one from Step 1, one from Step 6, and three from Step 8)
    • 4 comments on issues you didn't create (one from Step 6 and three from Step 8)
    • 4 issues created (one from Step 6 and three from Step 8)

Hint: You can track your progress with the number of pull requests and issues here.

→ Next: Step 9 - Planet Development Setup

Return to First Steps