You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
{{ message }}
This repository was archived by the owner on Jun 24, 2020. It is now read-only.
Copy file name to clipboardexpand all lines: README.md
+18-4
Original file line number
Diff line number
Diff line change
@@ -28,15 +28,15 @@ Note: the `nooku/nooku-framework` framework requirement will also install this i
28
28
29
29
To have Composer succesfully install your extension into Joomla, you need to make sure your repository layout resembles an installable Joomla package. This means that if you were to create an archive of your repository contents, that archive can be installed using the Joomla Extension Manager.
30
30
31
-
This means that you need to add a [valid XML manifest](http://docs.joomla.org/Manifest_files) to the root directory and make sure it points to the correct paths. For a working example, you can always refer to our [tada](https://github.com/nooku/nooku-pkg_tada/) example component!
31
+
This means that you need to add a [valid XML manifest](http://docs.joomla.org/Manifest_files) to the root directory and make sure it points to the correct paths. For a working example, you can always refer to our [todo](https://github.com/nooku/joomla-todo) example component!
32
32
33
33
#### Publishing
34
34
35
35
You can now publish your component on [Packagist](http://packagist.org) or [add your own repository](https://getcomposer.org/doc/05-repositories.md#vcs) to your Joomla's composer.json file. Your component can then be installed using the `composer install` command.
36
36
37
37
### Nooku Component
38
38
39
-
Use the `nooku-component` type to install your reusable Nooku components into your Joomla setup. The Composer installer will take your code and place it inside the `/libraries/vendor` directory. For Joomla versions prior to 3.4, it will install them into the `/vendor` folder.
39
+
Use the `nooku-component` type to install your reusable Nooku components into your Joomla setup or [Nooku Platform](http://www.nooku.org/platform) application. The Composer installer will take your code and place it inside the `/vendor` directory. For Joomla versions 3.4 and up, it will install into the `/libraries/vendor` folder.
40
40
41
41
Your package's `composer.json` file should contain at least the following directives:
42
42
@@ -90,12 +90,26 @@ Now execute `composer install` to install the framework.
90
90
91
91
## Contributing
92
92
93
-
Fork the project, create a feature branch, and send us a pull request.
93
+
We appreciate any contribution, whether it is related to bugs, grammar, or simply a suggestion or
94
+
improvement. We ask that any contribution follows a few simple guidelines in order to be properly received.
95
+
96
+
We follow the [GitFlow][gitflow-model] branching model, from development to release. If you are not familiar with it,
97
+
there are several guides and tutorials online to learn about it.
98
+
99
+
There are a few things you must know before submitting a pull request:
100
+
101
+
- All changes need to be made against the `develop` branch. However, it is very well appreciated and highly suggested to
102
+
start a new feature branch from `develop` and make your changes in this new branch. This way we can just checkout your
103
+
feature branch for testing before merging it into `develop`.
104
+
- We will not consider pull requests made directly to the `master` branch.
94
105
95
106
## Authors
96
107
97
108
See the list of [contributors](https://github.com/nooku/nooku-installer/contributors).
98
109
99
110
## License
100
111
101
-
The `nooku/installer` plugin is licensed under the GPL v3 license - see the [LICENSE](https://github.com/nooku/nooku-installer/blob/master/LICENSE) file for details.
112
+
The `nooku-installer` plugin t is free and open-source software licensed under the [GPLv3 license](gplv3-license).
0 commit comments