Skip to content

Managing Codemarks

planteater edited this page Sep 20, 2019 · 6 revisions

Organizing with Tags

Tags are a great way to broadly organize and group your team’s codemarks, and the possibilities here are endless. Here are just a few examples.

  • Create a set of codemarks that help introduce a codebase to new developers and tag them all with “Onboarding”.
  • When identifying issues in the code you could tag those that need to be addressed asap with a red “Critical” tag.
  • Identify which parts of the codebase represent tech debt with the tag “Refactor” and colored by priority.

You can add tags while creating a codemark or editing an existing one. Just look for the tag icon inside the compose box.

Adding Tags

Codelinks (Related Codemarks)

A codelink allows you to easily establish a connection between different parts of a codebase. two otherwise disconnected parts of your code. Here are some examples of when you might want to do this.

  • Accelerate the development process by providing technical guidance for a new project via a set of related codemarks.
  • Answer a question with an example somewhere else in the codebase by creating a codemark there and then adding the codemark where the question was asked as a related codemark.
  • When a change to one part of the codebase would require a change to another part, identify the dependency by creating two related codemarks.

You can add codelinks while creating a codemark or editing an existing one. Just look for the CodeStream icon inside the compose box.

Adding Codelinks

Editing & Deleting

Click the ellipses menu at the top-right of any codemark you authored to either edit or delete it. Note that in most cases it might make sense to archive (see below) a codemark instead of deleting it, so that the codemark can still provide some value down the road.

Codemark Menu

Archiving & Resolving

If there’s a codemark that you don’t think is important enough to continue to be on display when viewing the given file, but you don’t want to completely delete it, you can archive it via the ellipses menu at the top-right of the codemark. This will collapse it at the right side of the CodeStream pane, where you can easily click to expand it again. Similarly, when you mark an issue as resolved it’s collapsed as well.

Click on the “archived” or “resolved” filters in the toolbar at the bottom to quickly display all archived and/or closed codemarks.

Codemark Shortcut

Starred Replies

Some codemarks may warrant just a quick reply or two, while others may result in lengthy discussions among the team. If there’s a specific reply in the thread that represents “the answer”, star it so that it is displayed along with the codemark. Someone else looking at this codemark down the road won’t need to go hunting for the most relevant information.

Starred Reply

Keyboard Shortcuts

In addition to the shortcuts above for creating codemarks, you can also set a shortcut for any individual codemark by selecting "Set Keybinding" from the ellipses menu at the top-right of the codemark.

Codemark Shortcut

You can’t perform that action at this time.