Skip to content
New issue

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

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

Already on GitHub? # to your account

Create readme_template.md #1271

Merged
merged 3 commits into from
Sep 25, 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
88 changes: 88 additions & 0 deletions docs/contributing/readme_template.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,88 @@
`# ![Alt text](Mascot Image) Repository Name `

`[![Minimum PHP Version](link)](link)`
`[![Build Status](link)](link)`
`[![Contribution Guidelines](http://img.shields.io/badge/CONTRIBUTING-Guidelines-blue.svg)](./CONTRIBUTING.md)`
`[![LICENSE](https://img.shields.io/badge/license-MIT-blue.svg?style=flat-square)](./LICENSE)`
`[![codecov](link)](link)`

`## Introduction`

`A brief introduction and summary of the module.`

`## Requirements`

`This module requires the following modules/libraries:`

`* [Name](Link)`
`* [Name](Link)`
`* Any`
`* Requirements`

`## Installation`

`Installations instructions.`

`## Configuration`

`Describe path to configuration. `

`Include a screenshot of configuration page. When using your choice of screenshot software, resize your browser`
`first to avoid wide screenshots. Here are a few browser extension examples to take screenshots.`

`* [Fireshots](https://chrome.google.com/webstore/detail/take-webpage-screenshots/mcbpblocgmgfnpjjppndjkmgjaogfceg)`
`* [Nimbus](https://chrome.google.com/webstore/detail/nimbus-screenshot-screen/bpconcjcammlapcogcnnelfmaeghhagj)`

`To upload the image drag the image into the comment section of an existing Pull Request. `

`This will generate the image url link for you`
`![Configuration Screenshot](https://user-images.githubusercontent.com/2857697/39014759-e2ef9c1e-43e0-11e8-921c-c2a3234d65d2.jpg)`

`Video example on [How to attach an Image in README.md file with Github](https://youtu.be/wVHJtL-y7P0)`


`## Other Sections As Needed`

`Sections specific to this repo, but not found in all repos, should go here.`

`## Documentation`

`Further documentation for this module is available on the [Islandora 8 documentation site](https://islandora-claw.github.io/CLAW/).`

`## Troubleshooting/Issues`

`Having problems or solved a problem? Check out the Islandora google groups for a solution.`

`* [Islandora Group](https://groups.google.com/forum/?hl=en&fromgroups#!forum/islandora)`
`* [Islandora Dev Group](https://groups.google.com/forum/?hl=en&fromgroups#!forum/islandora-dev)`

`## FAQ`

`Q. Is this normal?`

`A. Yes. This is normal. Why ...`

`## Maintainers/Sponsors`

`Current maintainers:`

`* [Maintainer Name](https://github.com/maintainer_github)`
`* [Another Maintainer](https://github.com/maintainer_github)`

`This project has been sponsored by:`

`* Some really awesome sponsor`

`## Development`

`If you would like to contribute, please get involved by attending our weekly [Tech Call](https://github.com/Islandora-CLAW/CLAW/wiki). We love to hear from you!`

`If you would like to contribute code to the project, you need to be covered by an Islandora Foundation [Contributor License Agreement](http://islandora.ca/sites/default/files/islandora_cla.pdf) or [Corporate Contributor License Agreement](http://islandora.ca/sites/default/files/islandora_ccla.pdf). Please see the [Contributors](http://islandora.ca/resources/contributors) pages on Islandora.ca for more information.`

``We recommend using the [claw-playbook](https://github.com/Islandora-Devops/claw-playbook) to get started. If you want to pull down the submodules for development, don't forget to run `git submodule update --init --recursive` after cloning.``

`Also include any Travis gotcha's here. `

`## License`

`[Name](link). GPLv2 for Drupal modules. MIT for other modules. `