| 1 | # npm CLI Contributor Roles and Responsibilities
|
| 2 |
|
| 3 | ## Table of Contents
|
| 4 |
|
| 5 | * [Introduction](#introduction)
|
| 6 | * [Roles](#roles)
|
| 7 | * [Community Members](#community-members)
|
| 8 | * [Collaborators](#collaborators)
|
| 9 | * [npm, Inc Employeees](#npm-inc-employees)
|
| 10 |
|
| 11 |
|
| 12 | ## Introduction
|
| 13 |
|
| 14 | Welcome to the npm CLI Contributor Guide! This document outlines the npm CLI repository's process for community interaction and contribution. This includes the issue tracker, pull requests, wiki pages, and, to a certain extent, outside communication in the context of the npm CLI. It defines roles, responsibilities, and procedures, and is an entry point for anyone wishing to contribute their time and effort to making npm a better tool for the JavaScript community!
|
| 15 |
|
| 16 | All interactions in the npm repository are covered by the [npm Code of Conduct](https://www.npmjs.com/policies/conduct)
|
| 17 |
|
| 18 | ## Roles
|
| 19 |
|
| 20 | There are three main roles for people participating in the npm issue tracker. Each has a specific set of abilities and responsibilities: [Community members](#community-members), [Collaborators](#collaborators), and [npm, Inc employees](#npm-inc-employees).
|
| 21 |
|
| 22 | Failure to comply with the expected responsibilities of each role, or violating the Code of Conduct will result in punitive action relative to the transgression, ranging from a warning to full removal from the project, at the discretion of npm employees.
|
| 23 |
|
| 24 | ### Community Members
|
| 25 |
|
| 26 | This includes anyone who may show up to the npm/npm repo with issues, PRs, comments etc. They may not have any other involvement with npm.
|
| 27 |
|
| 28 | #### Abilities
|
| 29 |
|
| 30 | * Open issues and PRs
|
| 31 | * Comment on issues and PRs
|
| 32 |
|
| 33 | #### Responsibilities
|
| 34 |
|
| 35 | * Comment on issues when they have a reference to the answer.
|
| 36 | * If community members aren't sure they are correct and don't have a reference to the answer, please leave the issue and try another one.
|
| 37 | * Defer to collaborators and npm employees for answers.
|
| 38 | * Make sure to search for [the troubleshooting doc](./TROUBLESHOOTING.md) and search on the issue tracker for similar issues before opening a new one.
|
| 39 | * Any users with urgent support needs are welcome to email support@npmjs.com, and our dedicated support team will be happy to help.
|
| 40 |
|
| 41 | PLEASE don't @ collaborators or npm employees on issues. The CLI team is small, and has many outstanding commitments to fulfill.
|
| 42 |
|
| 43 | ### Collaborators
|
| 44 |
|
| 45 | These are folks who have the ability to label and close issues. The role of collaborators may expand over time, but for now it is a limited (& important) role. This is an excellent way to contribute to npm without writing code.
|
| 46 |
|
| 47 | Community members may become collaborators by showing consistent, proven track record of quality contributions to the project, a reasonable level of proficiency with the CLI, and regular participation through the tracker and other related mediums, including regular contact with the CLI team itself. This role entails a higher level of responsibility than community member, so we ask for a higher level of understanding and commitment.
|
| 48 |
|
| 49 | Collaborators who become inactive for 3 months or longer may have their collaborator privileges removed until they are ready to return.
|
| 50 |
|
| 51 | #### Abilities
|
| 52 |
|
| 53 | * Label/triage new issues
|
| 54 | * Respond to ongoing issues
|
| 55 | * Close resolved issues.
|
| 56 |
|
| 57 | #### Responsibilities
|
| 58 |
|
| 59 | * Only answer questions when they know the answer, and provide a reference to the answer.
|
| 60 | * If collaborators aren't totally confident about their answer, please leave the issue and try another one.
|
| 61 | * If they've responded to an issue, it becomes their responsibility to see it to resolution.
|
| 62 | * Close issues if there's no response within a month.
|
| 63 | * Defer to fellow Collaborators & npm employees for answers (Again, please don't @ collaborators or npm employees, thank you!)
|
| 64 | * Make sure to search for [the troubleshooting doc](./TROUBLESHOOTING.md) and search on the issue tracker for similar issues before opening a new one.
|
| 65 |
|
| 66 | ### npm, Inc Employees
|
| 67 |
|
| 68 | Folks who work at npm, Inc, who have a responsibility to ensure the stability and functionality of the tools npm offers.
|
| 69 |
|
| 70 | #### Abilities
|
| 71 | * Label/triage new issues
|
| 72 | * Respond to ongoing issues
|
| 73 | * Close resolved issues
|
| 74 | * Land PRs
|
| 75 |
|
| 76 | Please note that this is a living document, and the CLI team will put up PRs to it as needed.
|
| 77 |
|
| 78 | #### Responsibilities
|
| 79 |
|
| 80 | * Preserve and promote the health of the CLI, the registry, the website, etc.
|
| 81 |
|
| 82 | In special cases, [Collaborators](#collaborators) may request time to speak with an npm employee directly, by contacting them and coordinating a time/place.
|