Skip to content

Latest commit

 

History

History
38 lines (28 loc) · 2.61 KB

pr_issues.md

File metadata and controls

38 lines (28 loc) · 2.61 KB
Raw

Forks

Either fork the original repository or create a new branch on this repo to work on your weekly progress. Whatever is convenient for you.

How to create Issues:

  • Press on the Issues tab and then press New issue.
  • Select labels to describe the issue to other team members. Please take note of the differences between each label and what they stand for.
  • Choose a meaningful title. If the issues is about something that's to be done later on in the project or regarding our git repository - add TODO.
  • If the issue deals with bug/feature improvent, provide code snippet so other team members get proper understanding of the problem. To copy multiple lines go to the relevant file and press on the intended row line, hold shift and then press on another row line. This section will be colored in yellow and you should be able to copy that section to the new issue.
  • If you have suggestions about how to fix the bug or how to improve code, provide detailed explanation and steps using markdown.
  • Use markdown to make your message clearer.
    Please use this markdown tutorial if you need any help

How to create a Pull Request:

  • Press on the Pull requests tab and then press New pull request.
  • Choose your working branch or your forked repository you would like to sumbit for PR.
  • Denote which issue your PR closes with "closes #[number of issue]". You can use any one of the following words close, closes, closed, fixes, fixed. This way when the PR is merged it will automatically close the relevant issue.

How to review a Pull Request:

  • Press on the Pull requests tab and then press on one of the PRs in the list bellow.

  • Move to the Files changed tab and review the changes done to the code. Pay attention if the code makes sense.

  • You can comment on any given block of code and send a review to the team member who made the PR.

  • Above the changed code there is a button Review changes where you can choose between 3 options:

    • Comment : general feedback without explicit approval of merge.
    • Approve : approve the incoming merge.
    • Request changes : feedback that needs to be addressed before merging.

    Please use this PR approving guide if you need any help

Some other userful links