Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add Documentation for Adding Tools #202

Merged
merged 6 commits into from
May 13, 2019
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 16 additions & 0 deletions docs/drafts/onboarding-tools
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
# Creating Package Maintenance Tools

If you have an idea for a tool that can help our community to hold themselves accountable to the best practices identified by the Package Maintenance Team, follow the process below to get your idea from proposal to published.

1. Propose the tool here in the Package Maintenance Team repo by adding an issue describing your idea

2. Put your proposal on the [agenda for the next meeting](https://github.com/nodejs/package-maintenance/pulls?utf8=%E2%9C%93&q=is%3Apr+is%3Aopen+meeting+)

3. Discuss with the group during our team meeting so we can plan next steps. (See [Calendar](https://calendar.google.com/calendar/embed?src=nodejs.org_nr77ama8p7d7f9ajrpnu506c98@group.calendar.google.com) for date/time)

4. Build the tool as a public GitHub repo that follows Package Maintenance Team standards
- https://github.com/nodejs/package-maintenance/blob/master/docs/drafts/Baseline%20practice%20-%20Document%20support%20levels.md

5. Release your tool as a public npm module (following our [documented steps for publishing modules](https://github.com/nodejs/package-maintenance/blob/master/docs/drafts/PUBLISH-GUIDELINES.md))

6. **As Needed:** Follow the steps for [transferring your repo into the org](https://github.com/nodejs/admin/blob/master/transfer-repo-into-the-org.md).