Working with issues in SourceCraft

Issues is a tool for tracking bugs, improvements, and new feature requests within a project. In an issue, you can start a discussion in comments, set the job status, priority, and responsible employee.

See the video illustrating issue handling at Creating an issue in a SourceCraft repository.

Joining a discussion on an issue

You can use issues to maintain user activity in a project. Users may vote for an issue, discuss problems or ideas in comments, share their suggestions, and ask for clarifications.

They can use reactions, e.g., likes, dislikes, and other emojis, to acknowledge a relevant or helpful comment. Users can mention each other in a message with the @ symbol and add links to other issues, milestones, and pull requests to group related discussions and resolve issues faster.

SourceCraft supports updating issue pages in real time. You do not need to refresh the page manually to see new comments, reactions, and other changes.

Viewing an issue

  1. Open the SourceCraft home page.

  2. On the Home tab, under Your craftspace, navigate to Repositories.

    To view an issue in another user's repository, navigate to Repositories on the Discover tab.

  3. Select the repository with the issue you want to join a discussion on.

  4. Under Plan on the repository page, go to Issues.

    Note

    The issue list page supports the following filters:

    • Status
    • Priority
    • Assignee
    • Author
    • Labels
    • Milestone
    • Title

    You can sort issues by the following parameters:

    • Date created
    • Date updated
    • Votes

  5. Select the issue you want to join a discussion on.

    By default, issues open in a pop-up panel to the right of the issue list. To navigate to a new window, click in the top-right corner. To instantly open an issue in a new window, click it while holding down Command in macOS or Ctrl in Windows or Linux.

    Tip

    You can change the default issue display behavior in the interface settings.

    The issue displays statuses of its associated pull requests, including information about target branch merge failures.

Voting for an issue

In the top-right corner of the issue page, click Vote.

You can revoke your vote at any time by clicking the same button.

Leaving a comment

On the issue page under Activity, enter your comment and click Comment.

When commenting, you can use Yandex Flavored Markdown, attach files, add emojis, and mention users with @.

Descriptions and comments to issues and pull requests support short links to other issues and pull requests. Such entries automatically convert into hyperlinks that display a summary preview card on hover. Use the following formats:

  • !<pull_request_number>: Pull request in the current repository.
  • <repository_slug>!<pull_request_number>: Pull request in a different repository of the current organization.
  • <organization_slug>/<repository_slug>!<pull_request_number>: Pull request in the specified organization and repository.
  • #<issue_number>: Issue in the current repository.
  • <repository_slug>#<issue_number>: Issue in the a different repository of the current organization.
  • <organization_slug>/<repository_slug>#<issue_number>: Issue in the specified organization and repository.

Tip

You can create a new issue from a comment to a pull request or issue by clicking next to the comment and selecting Create issue.

To edit your comment, click in its top-right corner and select Edit.

To delete your comment, click in its top-right corner and select Delete.

Replying to a user

  1. In the top-right corner of the comment, click .
  2. Type your reply in the field that appears and click Comment.

Reacting to a comment

In the top-right corner of the comment, click and select an emoji.

Subscribing to notifications for an issue

To stay updated on new comments, reactions, and other events, subscribe to notifications for the issue. You will be getting these at the email linked to your account.

You will get issue notifications by default only if you are mentioned in a comment with @.

To subscribe to all issue notifications, click in the top-right corner of the issue page and select Subscribe.

To unsubscribe from all issue notifications, click in the top-right corner of the issue page and select Unsubscribe.

Editing an issue

  1. Open the SourceCraft home page.

  2. On the Home tab, under Your craftspace, navigate to Repositories.

  3. Select the repository you want to edit an issue in.

  4. Under Plan on the repository page, go to Issues.

    Note

    The issue list page supports the following filters:

    • Status
    • Priority
    • Assignee
    • Author
    • Labels
    • Milestone
    • Title

    You can sort issues by the following parameters:

    • Date created
    • Date updated
    • Votes

  5. Select the issue you want to edit.

  6. Edit its settings:

    • Enter a name for the issue.

    • Optionally, provide a detailed description of the issue or an idea for a new feature.

      Descriptions and comments to issues and pull requests support short links to other issues and pull requests. Such entries automatically convert into hyperlinks that display a summary preview card on hover. Use the following formats:

      • !<pull_request_number>: Pull request in the current repository.
      • <repository_slug>!<pull_request_number>: Pull request in a different repository of the current organization.
      • <organization_slug>/<repository_slug>!<pull_request_number>: Pull request in the specified organization and repository.
      • #<issue_number>: Issue in the current repository.
      • <repository_slug>#<issue_number>: Issue in the a different repository of the current organization.
      • <organization_slug>/<repository_slug>#<issue_number>: Issue in the specified organization and repository.

    • Optionally, attach additional files.

    • Under Priority, set priority:

      • Trivial: Trivial
      • Minor: Minor
      • Normal: Regular
      • Critical: Critical
      • Blocker: Blocker

    • Under Visibility, select issue access type:

      • Private: The issue can be accessed only by you.

      • Public: The issue can be accessed by any user with access to the repository.

        Note

        You can change the access level at any time.

    • Optionally, under Assignee, select the user responsible for the issue.

    • Optionally, under Labels, select the labels for the issue.

      You can select existing labels from the list or create a new one.

      To set the label color, click it and select the color from the drop-down list.

    • Optionally, under Milestone, select a milestone to link the issue with.

  7. To link the issue to other issues, click Link issue.

    Tip

    You can link issues from different repositories within one organization. The following link types are available:  Related issue,  Sub-issue,  Parent issue,  Blocker for,  Blocked by, and  Duplicate of.

    You can select an existing issue from the drop-down list or create a new one directly on the current page.

  8. To link the issue to a pull request, click Link pull request.

Adding labels

  1. Open the SourceCraft home page.
  2. On the Home tab, under Your craftspace, navigate to Repositories.
  3. Select a repository.
  4. Under Plan on the repository page, go to Issues.
  5. Select an issue.
  6. In the right-hand panel, under Labels, add labels.

Searching for an issue by label

  1. Open the SourceCraft home page.
  2. On the Home tab, under Your craftspace, navigate to Repositories.
  3. Select a repository.
  4. Under Plan on the repository page, go to Issues.
  5. In the search bar, select Labels, a condition, and enter the label name.

Adding labels

  1. Open the SourceCraft home page.
  2. On the Home tab, under Your craftspace, navigate to Repositories.
  3. Select a repository.
  4. Under Plan on the repository page, go to Issues.
  5. Select an issue.
  6. In the right-hand panel, under Labels, add labels.

Useful links

Previous
Creating an issue
Next
Working with an issue board