https://github.com/adobe/starter-repo
Documentation templates for use in open source and open development projects
https://github.com/adobe/starter-repo
docs opensource templates
Last synced: 5 days ago
JSON representation
Documentation templates for use in open source and open development projects
- Host: GitHub
- URL: https://github.com/adobe/starter-repo
- Owner: adobe
- License: apache-2.0
- Created: 2018-08-30T18:22:13.000Z (almost 8 years ago)
- Default Branch: main
- Last Pushed: 2024-04-08T12:48:44.000Z (over 2 years ago)
- Last Synced: 2026-04-21T04:09:55.544Z (4 months ago)
- Topics: docs, opensource, templates
- Size: 88.9 KB
- Stars: 42
- Watchers: 7
- Forks: 64
- Open Issues: 8
-
Metadata Files:
- Readme: README.md
- Contributing: .github/CONTRIBUTING.md
- License: COPYING.txt
- Code of conduct: CODE_OF_CONDUCT-Magento.md
Awesome Lists containing this project
README
# 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](./.github/CONTRIBUTING.md) for more information.
### Licensing
This project is licensed under the Apache V2 License. See [LICENSE](LICENSE) for more information.