Skip to content

Github Issue Workflow

Viewing an Issue on GitHub

  1. Go to your GitHub repository
  2. Click the Issues tab
  3. Select the issue you want to resolve
  4. Read the details, requests, and tags, and record the issue number.

Open the Project in Visual Studio

If you have cloned the GitHub repository to which the issue belongs to your computer, you can open the project as follows: 1. Visual Studio → File → Open → Project/Solution 2. Select the .sln file of the cloned repository

If the project is not yet cloned: Git → Clone Repository Paste the GitHub URL

Open a New Branch

A separate branch should always be opened to work on an issue.

  1. Go to the Git menu in Visual Studio.
  2. Click New Branch.
  3. Give the branch a suitable name according to the BRANCH-STRUCTURE.md document. [BRANCH-STRUCTURE] (https://github.com/TeknosolSource/Serender.Inventory/blob/develop/BRANCH-STRUCTURE.md).
  4. Example: bugfix/fix-stock-card
  5. Activate the branch with Create.

This isolates your changes from the main branch.

Make Code Changes to Resolve the Issue

You can now make code changes within Visual Studio to resolve the issue.

  1. Fix the bug.
  2. Add the new feature.
  3. Update the tests if necessary.
  4. Debug if necessary.

Commit

Once you've completed the changes, it's time to commit.

  1. Open the Git Changes window in Visual Studio.
  2. View the changed files.
  3. Specify the issue number as the Commit Message.
  4. Example: closed #50
  5. Github Pull Request Keywords: close, closes, closed, fix, fixes, fixed, resolve, resolves, resolved
  6. Commit All and continue the push.

Creating a Pull Request (PR)

After the push, follow these steps on GitHub: 1. Go to the GitHub repository. 2. The "Compare & Pull Request" button will appear for your new branch. 3. Reference the issue in the PR description. * closed #50 4. Submit the PR. 5. Wait for the review process to complete.

Once the PR is approved and merged, the issue is resolved.