adobe / starter-repo Goto Github PK

Documentation templates for use in open source and open development projects

License: Apache License 2.0

starter-repo's Introduction

Open Source Starter Repo

This repository contains templates for project documentation, ensuring necessary legal and contributor documentation is explicit. All sections below in this README.md should be considered a template for a typical project README.md.

PROJECT NAME

A short description of what this project does.

Goals

It is a good idea to provide a mission statement for your project, enshrining what the project wants to accomplish so that as more people join your project everyone can work in alignment.

Non-Goals

It is also a good idea to declare what are not goals of the project to prevent potential feature creep.

Installation

Instructions for how to download/install the code onto your machine.

Example:

npm install myProject --save

Usage

Usage instructions for your code.

Example:

var myMod = require('mymodule');

myMod.foo('hi');

Contributing

Contributions are welcomed! Read the Contributing Guide for more information.

Licensing

This project is licensed under the Apache V2 License. See LICENSE for more information.

starter-repo's People

Contributors

Stargazers

Watchers

starter-repo's Issues

Community health files

Expected Behaviour

GitHub has updated the documentation for "Community health file," and we could have some of the files updated in this starter repo to meet the guidelines. I'm copying the table of the supported files to show what we have and what we could improve.

Community health file	Description	Status in this repo
CODE_OF_CONDUCT.md	A CODE_OF_CONDUCT file defines standards for how to engage in a community. For more information, see "Adding a code of conduct to your project."	🟢 CODE_OF_CONDUCT.md
CONTRIBUTING.md	A CONTRIBUTING file communicates how people should contribute to your project. For more information, see "Setting guidelines for repository contributors."	🟢 CONTRIBUTING.md
Discussion category forms	Discussion category forms customize the templates that are available for community members to use when they open new discussions in your repository. For more information, see "Creating discussion category forms."	🔴 Note: Discussion category forms are currently in limited public beta and subject to change.
FUNDING.yml	A FUNDING file displays a sponsor button in your repository to increase the visibility of funding options for your open source project. For more information, see "Displaying a sponsor button in your repository."	Not applicable to Adobe
Issue and pull request templates and config.yml	Issue and pull request templates customize and standardize the information you'd like contributors to include when they open issues and pull requests in your repository. For more information, see "About issue and pull request templates."	🟡 We have the old template, but it should be updated to the new format. Existing issue: #17
SECURITY.md	A SECURITY file gives instructions for how to report a security vulnerability in your project. For more information, see "Adding a security policy to your repository."	🔴 Existing issue: #9
SUPPORT.md	A SUPPORT file lets people know about ways to get help with your project. For more information, see "Adding support resources to your project."	🔴

Add comment to issue template

For the issue template I think we should add a comment at the top that reminds the user of two things:

Did they search the repository to see if the issue has already been raised? This helps reduce duplicate issues.
If this is a security disclosure please follow the guidelines in CONTRIBUTING.md. This helps keep folks from accidentally releasing vulnerabilities before the maintainers get a chance to fix the issue.

If I get a couple of 👍 I'll send a PR with some wordsmithing.

Documentation-specific issue and pull request template

Expected Behaviour

It would be really helpful if there were standard ISSUE_TEMPLATE.md and PULL_REQUEST_TEMPLATE.md files which were useful for documentation-only projects.

Actual Behaviour

These don't exist :(

Update Issue Template scheme

ISSUE_TEMPLATE.md currently shows a message that we are "using an old version of issue templates" and that we should update "to the new issue template workflow" which allows multiple templates for different issue types. More details here.

We should consider updating starter-repo to use this new scheme.

"workflow" folder should be "workflows"

https://github.com/adobe/starter-repo/tree/master/.github/workflow
should be
https://github.com/adobe/starter-repo/tree/master/.github/workflows

(GitHub does not recognize workflow files if the folder is named "workflow")

Content for SECURITY.md

Possible content to use in a generic SECURITY.md policy file:

Reporting Security Issues

Adobe values the contributions of the security research community, and we look forward to working with you to minimize risk to users.

Where should I report security issues?

We strongly encourage you to report all security issues privately via our vulnerability disclosure program. Please provide us with relevant technical details and repro steps to expedite our investigation. If you prefer not to use HackerOne, email us directly at [email protected] with details and repro steps.

LICENSE_HEADER.md contains a link to corp url

74:To learn more about Adobe copyright, checkout our [Copyrights documentation](https://inside.corp.adobe.com/intellectual-property/copyrights.html#jcr-content_par_tab_Adobe-Copyright-Notices).

Mark as Template Repository

This repo should be a template repository.

adobe / starter-repo Goto Github PK

starter-repo's Introduction

Open Source Starter Repo

PROJECT NAME

Goals

Non-Goals

Installation

Usage

Contributing

Licensing

starter-repo's People

Contributors

Stargazers

Watchers

Forkers

starter-repo's Issues

Expected Behaviour

Expected Behaviour

Actual Behaviour

Reporting Security Issues

Where should I report security issues?

Recommend Projects

Recommend Topics

Recommend Org