Writing GitHub issues

Creating a new issue

Please refer to these instructions from GitHub to learn how to create a new issue.

OpenScPCA will prompt you with a selection of issues from our issue templates. See our documentation on OpenScPCA issue Templates for more about how to use the templates.

Markdown

GitHub Issues are written in Markdown, a plain text language for formatting documents. See our documentation on Markdown for more information about writing in Markdown.

Using mentions

Sometimes, you may need a Data Lab team member or another contributor to take a look at your issue! You can use mentions to direct people's attention to your issue or a comment.

To mention someone, use @{GitHub handle}, replacing everything after @ (including the curly brackets {}) with the person's GitHub handle; there is no need to use backticks around the mention.

You can find more information about mentioning people in GitHub's documentation.

It can be helpful to refer to related issues or pull requests when you are writing an issue to provide extra context for others and help keep the project organized.

Use the number of the GitHub issue or pull request, preceded by a number sign (#), to reference it. For example, to reference https://github.com/AlexsLemonade/OpenScPCA-analysis/issues/243, you would write #243 in the body of the issue.

You can read more about referencing issues and pull requests, included advanced usage, in GitHub's documentation.

Labels

You can use issue labels to help you filter existing issues. See GitHub's documentation on filtering issues and pull requests by labels for more information.

Applying labels

You will not have permissions to apply labels to issues yourself. Please mention a Data Lab team member to ask for a label to be applied to an issue you've created.