tonyair/silverstripe-framework
1
0
Fork 0
mirror of https://github.com/silverstripe/silverstripe-framework synced 2024-10-22 14:05:37 +02:00
Code Issues Projects Releases Wiki Activity

Merge pull request #6745 from open-sausages/pulls/4.0/license-supported-modules

Browse Source 
Require LICENSE in supported modules (no *.md)
This commit is contained in:
Damian Mooyman 2017-03-29 10:52:22 +13:00 committed by GitHub
commit 9146730a74
1 changed files with 1 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
docs/en/02_Developer_Guides/05_Extending/00_Modules.md
View File

@ -140,7 +140,7 @@ Documentation will use the following format:
* Security, license, links to more detailed docs. * Security, license, links to more detailed docs.
* CONTRIBUTING.md explaining terms of contribution. * CONTRIBUTING.md explaining terms of contribution.
* A changelog: CHANGELOG.md (may link to other more detailed docs or GitHub releases if you want). You could [use a changelog generator](https://github.com/skywinder/Github-Changelog-Generator) to help create this. * A changelog: CHANGELOG.md (may link to other more detailed docs or GitHub releases if you want). You could [use a changelog generator](https://github.com/skywinder/Github-Changelog-Generator) to help create this.
* Has a licence (LICENSE.md file) - for SilverStripe supported this needs to be BSD. * Has a licence (`LICENSE` file) - for SilverStripe supported this needs to be BSD.
* Detailed documentation in `/docs/en` as a nested set of GitHub-compatible Markdown files. * Detailed documentation in `/docs/en` as a nested set of GitHub-compatible Markdown files.
* It is suggested to use a documentation page named `userguide.md` in `docs/en/` that includes documentation of module features that have CMS user functionality (if applicable). For modules with large userguides, this should be in a directory named `userguide` with an `index.md` linking to any other userguide pages. * It is suggested to use a documentation page named `userguide.md` in `docs/en/` that includes documentation of module features that have CMS user functionality (if applicable). For modules with large userguides, this should be in a directory named `userguide` with an `index.md` linking to any other userguide pages.
* Links and image references are relative, and are able to be followed in viewers such as GitHub. * Links and image references are relative, and are able to be followed in viewers such as GitHub.