Skip to content

Commit

Permalink
update docs and guidelines (#34)
Browse files Browse the repository at this point in the history
  • Loading branch information
jsirish authored Jun 2, 2019
1 parent 22fb391 commit c89ce2b
Show file tree
Hide file tree
Showing 6 changed files with 61 additions and 3 deletions.
16 changes: 16 additions & 0 deletions .github/ISSUE_TEMPLATE.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
## Affected Version

Show version numbers by pasting the output of `composer info --direct`.
Alternatively, get the framework version information from the CMS.
In SilverStripe 4.3 and newer you may find the Help menu in the bottom left corner, unfold it and hover over the version number to get the information.
Otherwise, simply hover over the SilverStripe logo in the bottom left corner of the CMS.

## Description

Describe expected and observed behaviour.
For visual issues, please include browser version and screenshots.
Please read [our contributing docs](../CONTRIBUTING.md).

## Steps to Reproduce

Help us with step-by-step instructions.
5 changes: 5 additions & 0 deletions .github/PULL_REQUEST_TEMPLATE.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
Thanks for contributing, you're awesome! :star:
Please describe expected and observed behaviour, and what you're fixing.
For visual fixes, please include tested browsers and screenshots.
Search for related existing issues and link to them if possible.
Please read [our contributing docs](../CONTRIBUTING.md).
13 changes: 12 additions & 1 deletion CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,14 @@
# Contributing
- Maintenance on this module is a shared effort of those who use it
- To contribute improvements to the code, ensure you raise a pull request and discuss with the module maintainers
- Please follow the SilverStripe [code contribution guidelines](https://docs.silverstripe.org/en/contributing/code/) and [Module Standard](https://docs.silverstripe.org/en/developer_guides/extending/modules/#module-standard)
- Supply documentation that followS the [GitHub Flavored Markdown](https://help.github.com/articles/markdown-basics/) conventions
- When having discussions about this module in issues or pull request please adhere to the [SilverStripe Community Code of Conduct](https://docs.silverstripe.org/en/contributing/code_of_conduct/)

Contributions are welcome! Create an issue, explaining a bug or proposal. Submit pull requests if you feel brave.

## Contributor license agreement
By supplying code to this module in patches, tickets and pull requests, you agree to assign copyright
of that code to Dynamic, on the condition that these code changes are released under the
same BSD license as the original module. We ask for this so that the ownership in the license is clear
and unambiguous. By releasing this code under a permissive license such as BSD, this copyright assignment
won't prevent you from using the code in any way you see fit.
2 changes: 1 addition & 1 deletion LICENSE.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
Copyright (c) 2017, Dynamic
Copyright (c) 2018, Dynamic
All rights reserved.

Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:
Expand Down
27 changes: 26 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,6 +23,10 @@ A block that displays content in collapsable panels.

`composer require dynamic/silverstripe-elemental-accordion`

## License

See [License](license.md)

## Usage

A block that allows you to create collapsible content blocks.
Expand Down Expand Up @@ -59,4 +63,25 @@ See [SilverStripe Elemental Configuration](https://github.com/dnadesign/silverst

The translations for this project are managed via [Transifex](https://www.transifex.com/dynamicagency/silverstripe-elemental-accordion/)
and are updated automatically during the release process. To contribute, please head to the link above and get
translating!
translating!

## Maintainers

* [Dynamic](http://www.dynamicagency.com) (<[email protected]>)

## Bugtracker
Bugs are tracked in the issues section of this repository. Before submitting an issue please read over
existing issues to ensure yours is unique.

If the issue does look like a new bug:

- Create a new issue
- Describe the steps required to reproduce your issue, and the expected outcome. Unit tests, screenshots
and screencasts can help here.
- Describe your environment as detailed as possible: SilverStripe version, Browser, PHP version,
Operating System, any installed SilverStripe modules.

Please report security issues to the module maintainers directly. Please don't file security issues in the bugtracker.

## Development and contribution
If you would like to make contributions to the module please ensure you raise a pull request and discuss with the module maintainers.
1 change: 1 addition & 0 deletions code-of-conduct.md
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
When having discussions about this module in issues or pull request please adhere to the [SilverStripe Community Code of Conduct](https://docs.silverstripe.org/en/contributing/code_of_conduct).

0 comments on commit c89ce2b

Please sign in to comment.