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

Issue/309 docs table of contents #333

Merged
merged 6 commits into from May 30, 2020
Merged
Show file tree
Hide file tree
Changes from 3 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
28 changes: 25 additions & 3 deletions docs/README.md
@@ -1,5 +1,27 @@
# DOCS

This is the location for documentation, guide and other
information developed by the package-maintenance
team.
This is the location for documentation, guides and other information developed by the package-maintenance team. It is intended to provide as a set of resources and references for all package developers and maintainers.
Eomm marked this conversation as resolved.
Show resolved Hide resolved


## Goals and Objectives
By providing these guidelines and recommendations, the hope is that projects can benefit from the combined experience of the Node.js project and the community at large in a way that helps facilitate knowledge sharing and collaboration. For example, documentation for topics like Continuous Integration can be used to share tooling configurations and setups that can help reduce the barrier to entry and time needed for authors to setup their own projects.

> _In the spirit of open source, we are always open to contributions to help improve these docs, so if you find anything missing or that could be improved, please don't hesitiate to open an issue or PR for the team._


## Notes / Assumptions
thescientist13 marked this conversation as resolved.
Show resolved Hide resolved
As Node.js and most of the packages in the ecosystem are predominantly hosted on GitHub, there will be a natural leaning towards the features and capabilities provided by the GitHub platform referenced in these docs. However, we understand that not one size fits all and so will aim to provide recommendations that are well rounded. In this way, we want to at least communicate the foundational elements such that this information can and then be applied in whatever way fits a package's given workflow.


## Table of Contents
1. [Licensing](./licensing.md)
1. [Repository Settings (draft)](./drafts/repository-settings.md)
1. [Continuous Integration / Delivery (draft)](./drafts/ci-cd-guidelines.md)
1. [Workflows (draft)](./drafts/workflows.md)
1. [Code of Conduct (draft)](./drafts/code-of-conduct.md)
1. [Security (draft)](./drafts/security-guidelines.md)
1. [Testing (draft)](./drafts/code-of-conduct.md)
1. [Publishing Guidelines (draft)](./drafts/PUBLISH-GUIDELINES.md)
1. [Versioning](./versioning.md)
1. [Support (draft)](./drafts/PACKAGE-SUPPORT.md)
1. [Governance (draft)](./drafts/governance.md)
3 changes: 3 additions & 0 deletions docs/drafts/code-of-conduct.md
@@ -0,0 +1,3 @@
# Code of Conduct

TBD
3 changes: 3 additions & 0 deletions docs/drafts/governance.md
@@ -0,0 +1,3 @@
# Governance

TBD
11 changes: 11 additions & 0 deletions docs/drafts/repository-settings.md
@@ -0,0 +1,11 @@
# Respository Settings

Maintaining a repository should be something that can be configured to your project's preferred workflow and cadence through the code hosting platform of preference. Below are some recommendations and thoughts on various options that be enabled to facilite contributions and commits in a repository.

## Managing Access


## Branch Permissions


## Greenkeeper / Dependabot
22 changes: 22 additions & 0 deletions docs/drafts/workflows.md
@@ -0,0 +1,22 @@
# Workflows

As contributions come into a project, establishing a clear roadmap for the project, expections for code quality and formatting, communication channels, and more, can make the workflows for both maintainers and contributors clear and help manage and set expectations. Below are some considerations to keep in mind as you steer your projects.

## Contributing Guidelines
- Contributing.md
thescientist13 marked this conversation as resolved.
Show resolved Hide resolved

## Roadmap
- pointing contributor's in the right direction
- defining priorities for the project
- Projects / Milestones / Labels (good first issue, pinned issues)

## Issue Templates
- really good for bug reports
- RFCs can be a good way to facilitate technical design discussions, project stewardship

## Automation
- linting
- testing
- link out CI / CD guidelines

## Code Owners