Skip to content

Latest commit

 

History

History
29 lines (18 loc) · 1.18 KB

CONTRIBUTING.md

File metadata and controls

29 lines (18 loc) · 1.18 KB

Contributing to graphql-sse

Reporting Issues

Issues are for bugs or features. Please consider the following checklist.

Checklist

  • Does your title concisely summarize the problem?
  • Is it possible for you to include a minimal, reproducable example? Is it an SSCCE?
  • What OS and browser are you using? What versions?
  • Did you use a Issue Template?

General Guidelines

  • Keep it concise. Longer issues are harder to understand.
  • Keep it focused. Solving three vague problems is harder than solving one specific problem.
  • Be friendly! Everyone is working hard and trying to be effective.

This repository follows the Angular Commit Message Conventions for auto-generating the documentation and keeping readability high.

Comments in Code

We use a convention for comments in code: {NOTE/FIXME/TODO}-{initials}-{YYMMDD} descriptive text

so for example: // TODO-db-19001 leaving a todo note here for the next guy (or future me)