Completing a Dev Issue

Completing an Issue

So you've been assigned an issue, now what? How does that issue make it from your computer into the code base? This is a comprehensive guide to completing an issue.

1. Prepare Your Changes:

• Make Your Changes: Implement your changes or fixes in your local development environment.
• Stage Your Changes:
  • Add the changes to the staging area using the git add command. You can add individual files or all changes at once:
    • For specific files, use:

      git add <filename>
      

    • For all changes, use:

      git add .
      

• Commit Your Changes:
  • After staging your changes, commit them to your local branch with a meaningful commit message using:

    git commit -m "Your meaningful commit message"
    

  • Ensure that your commit message clearly describes the changes you have made.
• Run Reformatter and Linter: Before pushing your changes, ensure code quality by running our predefined reformatter and linter. Use the command: npm run lint:fix

2. Push Changes to GitHub:

• Commit Your Changes: After making changes, commit them to your local branch.
• Push to GitHub: Push your committed changes to the remote repository on GitHub using: git push origin BRANCHNAME

Replace BRANCHNAME with the name of your branch.

3. Create Pull Request on GitHub:

• Open Pull Requests Tab: Navigate to the 'Pull Requests' tab on your GitHub repository page.
• Initiate New Pull Request: Click the "New pull request" button.
• Set Base Branch: Ensure that the base branch is set to base:dev.
• Set Compare Branch: Ensure that the compare branch is set to the local branch you created and are pushing the changes with.
• Provide PR Details:
  • Title: Create a concise and meaningful title for your PR, use the issue number infront of your title like so: #411-fix footer this provides the reviewer with clear insight on what issue this PR is regarding.
  • Description: Add a detailed description of the changes. Explain why these changes are necessary and how they address the issue.

4. Post PR for Review:

• Move Issue to 'Ready for Review': In our project board move the associated issue to the "Ready for Review" section.
• Notify Team: Post in the #expunge-assist-dev channel with a link to your newly created PR.

5. Review and Merge:

• Peer Review: Wait for at least one approval from your teammates. Address any feedback or changes requested.
• Final Approval and Merge: After receiving the necessary approval(s), assign the PR to the Development Lead for final review and merging into the dev branch.