Skip to content

Commit

Permalink
updated readme/contributing.md files
Browse files Browse the repository at this point in the history
  • Loading branch information
@robfrawley
robfrawley committed Jun 17, 2016
1 parent a9e57ab commit 5fb8bfd
Showing 1 changed file with 74 additions and 73 deletions.
147 changes: 74 additions & 73 deletions README.md
View file
Original file line number Diff line number Diff line change
@@ -1,48 +1,61 @@

# [src-run] wonka-bundle

| Continuous Integration | Code Quality Review | UnitTest Coverage |
|:----------------------:|:-----------------------:|:-----------------------:|
| [![Travis](https://src.run/wonka-bundle/travis_shield)](https://src.run/wonka-bundle/travis) | [![Codacy](https://src.run/wonka-bundle/codacy_shield)](https://src.run/wonka-bundle/codacy) | [![Coveralls](https://src.run/wonka-bundle/coveralls_shield)](https://src.run/wonka-bundle/coveralls) |
| Travis-CI | Codacy Rating | Code Coverage | Style-CI |
|:----------------------:|:-----------------------:|:-----------------------:|:-----------------------:|
| [![Travis](https://src.run/wonka-bundle/travis.svg)](https://src.run/wonka-bundle/travis) | [![Codacy](https://src.run/wonka-bundle/codacy.svg)](https://src.run/wonka-bundle/codacy) | [![Coveralls](https://src.run/wonka-bundle/coveralls.svg)](https://src.run/wonka-bundle/coveralls) | [![Coveralls](https://src.run/wonka-bundle/styleci.svg)](https://src.run/wonka-bundle/styleci) |


## Overview

[Welcome](https://src.run/go/readme_welcome)!
The `src-run/wonka-bundle` package provides
a collection of classes and interfaces aimed at facilitating Symfony
bundle's, including helpers for advanced bundle configuration, kernel
compiler passes, and more.
The `src-run/wonka-bundle` package provides the following

> a collection of classes and interfaces aimed at facilitating Symfony bundle's, including helpers for advanced bundle configuration, kernel compiler passes, and more
### Grouping

This package is part of the [wonka](https://src.run/wonka-bundle/group)
group ([explanation](https://src.run/wonka-bundle/group_explanation)),
comprised of other releases with a concentration in
*core, rudimentary routines*,
and related functionality.
We use a Willy Wonka-inspired naming schema for our package group names. This package is part of the
[wonka group](https://src.run/wonka-bundle/group), which is a collection of packages with a focus
on "core reflection base classes" and related functionality.

You are welcome to research some [useless details](https://src.run/wonka-bundle/group_explanation)
about this specific group if you have too much time on your hands.

### JTT

This package represents a single project within a
[large collection](https://src.run/go/explore) of open-source code released
under the *SR* namespace, comprised of framework-agnostic libraries,
and a number of Symfony bundles. These projects are authored and maintained
by [Rob Frawley 2nd](https://src.run/rmf) and
[collaborators](https://src.run/wonka-bundle/github_collaborators).
This package represents a single project within a [large collection](https://src.run/go/explore) of open-source code
released under the "SR" namespace, comprised of many framework-agnostic libraries, a collection of Symfony bundles, as
well as some one-off releases. This project is authored and maintained by:

- [Rob Frawley 2nd](https://src.run/rmf)
- [Collaborators](https://src.run/wonka-bundle/github_collaborators)


## Quick Start

### Installation

Get the code by requiring it explicitly via the [Composer](https://getcomposer.com)
CLI, or by editing your *composer.json* to reflect the dependency and updating
your project requirements. For example, to explicitly require this project using
the CLI, use the following command.
Get the code by requiring it explicitly via the [Composer](https://getcomposer.com) CLI, or by editing your
*composer.json* to reflect the dependency and updating your project requirements. For example, to explicitly require
this project using the CLI, use the following command.

```bash
$ composer require src-run/wonka-bundle
```

Alternatively, to add this project to your "composer.json" file, add the following to the "require" section.

```json
require: {
"src-run/wonka-bundle": "dev-master"
}
```

*Note: Is is not recommended to use the "dev-master" constraint. Realize that doing so could allow a release with
backwards-incompatable, breaking changes to be pulled in. Instead, it is good practive to use semantic versioning and
enter an explicit requirement. For example, to require version 1.0 you would use `^1.0`.*

To enable the bundle, register it with your Symfony application kernel by
instantiating *ScribeWonkaBundle* within the bundle array.

Expand All @@ -52,7 +65,7 @@ class AppKernel extends Kernel {
public function registerBundles() {
$bundles = [
// ...
new SR\WonkaBundle\ScribeWonkaBundle(),
new SR\WonkaBundle\WonkaBundle(),
];
// ...
}
Expand All @@ -70,77 +83,65 @@ the following.
bin/wonka config:dump-reference scribe_wonka
```


## Reference

### API Docs

This package's API-documentation is available at [src.run/wonka-bundle/api](https://src.run/wonka-bundle/api),
(as well as linked below via the *Reference* badge found under the *Additional Links*
header). All API-reference is build against the *master* Git branch and updated
automatically on each Git push---api-reference for *specific releases* will
be provided once this package has matured.

> The entire API-reference website is auto-generated using a quick,
> reliable, and well-developed CLI tool called [Sami](https://src.run/go/sami).
> It is rigerously and regularly tested through its use in large, complex projects,
> such as the [Symfony Full-Stack Framework](https://src.run/go/symfony)
> <see: [src.run/go/api-ref-symfony](https://src.run/go/symfony-api)>, as well
> as its use in smaller projects such
> [Twig](https://src.run/go/sami-twig)
> <see: [src.run/go/api-ref-twig](https://src.run/go/twig-api)>.
> Reference Sami's [GitHub page](https://src.run/go/sami) to learn how to use
> it with your own projects!
This package's API reference is available on our documentation website (see the "Reference" row of the table found in
the "Additional Links" section below). All API documentation is automatically compiled against the master branch
whenever a git push event occurs.

*Static API reference for specific releases is planned and will be posted once this package has matured and reached
the version 1 milestone*.

> The API reference websites detailed above are auto-generated using a reliable and well-developed CLI tool called
> [Sami](https://src.run/go/sami). It is rigorously and regularly tested and is used for some large-scale projects, such
> as the [Symfony Full-Stack Framework](https://src.run/go/symfony) <see: https://src.run/go/symfony-api>, as well some
> smaller projects, such as [Twig](https://src.run/go/sami-twig) <see: https://src.run/go/twig-api>. Refer to Sami's
> [repository page](https://src.run/go/sami) to research usage in your own project.
### Examples/Tutorials

Currently, there is no *"human-written"* documentation---outside of this README.
Pending package stability and available resources, a
[RTD (Read the Docs)](https://src.run/go/rtd) page will be published with
additional information and tutorials, including real use-cases within the Symfony
Framework.
Currently, there is no "human-written" documentation, outside of this README (which is itself generated from a
template). Pending package stability, available man-hours, and an actual demand from external users, we may publish
a [Read the Docs](https://src.run/go/rtd) page with official documentation, tutorials, and additional resources.


## Contributing

### Discussion

For general inquiries or to discuss a broad topic or idea, you can find
*robfrawley* on Freenode. There is also a *#scribe* channel, which can
be joined using the following link
[irc.choopa.net:6669/scribe](irc://irc.choopa.net:6669/scribe).
For general inquiries or to discuss a broad topic or idea, find "robfrawley" on Freenode. He is always happy to
discuss language-level ideas, possible new directions for a project, emerging technologies, as well as the weather.

### Issues

To report issues or request a new feature use
[GitHub](https://src.run/wonka-bundle/github_issues)
or [GitLab](https://src.run/wonka-bundle/gitlab_issues)
to start a discussion. Include as much information as possible to aid in
a quick resolution. Feel free to "ping" the topic if you don't get a
response within a few days.
To report issues or request a new feature, use the [project issue tracker](https://src.run/wonka-bundle/github_issues).
Include as much information as possible in any bug reports. Feel free to "ping" the topic if you don't get a response
within a few days (sometimes Github notification e-mails fall through the cracks).

### Code

You created additional functionality during the use of this package? Send
it back upstream! *Don't hesitate to submit a pull request!* Beyond the
brief requirements outlined in the
[contibuting guide](https://src.run/wonka-bundle/contributing),
your [imagination](https://src.run/go/readme_imagination)
represents the only limitation.
You created additional functionality while utilizing this package? Wonderful: send it back upstream! *Don't hesitate to
submit a pull request!* Your [imagination](https://src.run/go/readme_imagination) and the requirements outlined within
our [CONTRIBUTING.md](https://src.run/wonka-bundle/contributing) file are the only limitations.


## License

This project is licensed under the
[MIT License](https://src.run/go/mit), an
[FSF](https://src.run/go/fsf)-/[OSI](https://src.run/go/osi)-approved
and [GPL](https://src.run/go/gpl)-compatible, permissive free software
license. Review the
[LICENSE](https://src.run/wonka-bundle/license)
file distributed with this source code for additional information.
This project is licensed under the [MIT License](https://src.run/go/mit), an [FSF](https://src.run/go/fsf)- and
[OSI](https://src.run/go/osi)-approved, [GPL](https://src.run/go/gpl)-compatible, permissive free software license.
Review the [LICENSE](https://src.run/wonka-bundle/license) file distributed with this source code for additional
information.


## Additional Links

| Purpose | Status |
|--------------:|:--------------|
| *Stable Release* | [![Packagist](https://src.run/wonka-bundle/packagist_shield)](https://src.run/wonka-bundle/packagist) |
| *Dev Release* | [![Packagist](https://src.run/wonka-bundle/packagist_pre_shield)](https://src.run/wonka-bundle/packagist) |
| *License* | [![License](https://src.run/wonka-bundle/license_shield)](https://src.run/wonka-bundle/license) |
| *Reference* | [![License](https://src.run/wonka-bundle/api_shield)](https://src.run/wonka-bundle/api) |
| Item | Result/Status |
|-------------------:|:-------------------------------------------------------------------------------------------------------------------|
| __Stable Release__ | [![Packagist](https://src.run/wonka-bundle/packagist.svg)](https://src.run/wonka-bundle/packagist) |
| __Dev Release__ | [![Packagist](https://src.run/wonka-bundle/packagist_pre.svg)](https://src.run/wonka-bundle/packagist) |
| __License__ | [![License](https://src.run/wonka-bundle/license.svg)](https://src.run/wonka-bundle/license) |
| __Reference__ | [![License](https://src.run/wonka-bundle/api.svg)](https://src.run/wonka-bundle/api) |

0 comments on commit 5fb8bfd

Please sign in to comment.