Skip to content

Commit 0c654c3

Browse files
discordierdiscordier
committed
Add github templates, LICENSE and .gitattributes
1 parent f3e7208 commit 0c654c3

5 files changed

+293
-0
lines changed

‎.gitattributes

+9
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
.check-author.yml
2+
.gitattributes export-ignore
3+
.gitignore export-ignore
4+
.travis.yml export-ignore
5+
build.default.properties export-ignore
6+
build.xml export-ignore
7+
phpunit.xml.dist export-ignore
8+
/.github export-ignore
9+
/tests export-ignore

‎.github/CONTRIBUTING.md

+66
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,66 @@
1+
# How to contribute
2+
3+
We are really glad you're reading this, because we need volunteer developers to
4+
help this project come to fruition.
5+
6+
If you haven't already, come find us in IRC (#contao.mm on freenode).
7+
We want you working on things you're excited about.
8+
9+
The following is a set of guidelines for contributing to MetaModels and its
10+
packages, which are hosted in the [MetaModels organization][1] on GitHub. These
11+
are just guidelines, not rules, use your best judgement and feel free to
12+
propose changes to this document in a pull request.
13+
14+
## Submitting issues
15+
16+
* Use the search function to see if a similar issue has already been submitted.
17+
* Describe the issue in detail and include all the steps to follow in order to
18+
reproduce the bug.
19+
* Include the version of Contao, PHP and MetaModels you are using (if possible
20+
with a detailed list of other installed extensions that might be related).
21+
* Include screenshots or screencasts if possible; they are immensely helpful.
22+
* If you are reporting a bug, please include any related error message you are
23+
seeing and also check the `system/logs/error.log` file. The error message is
24+
not just the message but also the complete(!) stack trace below the message.
25+
This trace is a long list of function calls which helps us to diagnose the
26+
problem en detail.
27+
28+
## Submitting changes
29+
30+
* Please send a [GitHub Pull Request to MetaModels][1] with a clear list of what
31+
you've done (read more about [pull requests][2]).
32+
* When you send a pull request, we will love you forever if you include
33+
phpunit tests. We can always use more test coverage.
34+
* Please follow the [phpcq 2.0][3] coding standards.
35+
* Please make sure all of your commits are atomic (only one feature or fix per
36+
commit).
37+
* We use phpcq/all-tasks in these projects, so please check your changes
38+
using phpcq when submitting a pull request.
39+
* Create your pull request against the [`master`][4] branch for bug fixes or the
40+
[`develop`][5] branch for new features.
41+
* Include screenshots in your pull request whenever possible.
42+
43+
Always write a clear log message for your commits.
44+
One-line messages are fine for small changes, but bigger changes should look
45+
like this:
46+
47+
$ git commit -m "A brief summary of the commit
48+
>
49+
> A paragraph describing what changed and its impact."
50+
51+
## Testing
52+
53+
We have a handful of unit tests. Please write unit tests for new code you
54+
create.
55+
56+
## Git commit messages
57+
58+
* Use the present tense ("Add feature" not "Added feature").
59+
* Use the imperative mood ("Move cursor to …" not "Moves cursor to …").
60+
* Reference issues and pull requests liberally.
61+
62+
[1]: https://github.com/MetaModels
63+
[2]: http://help.github.com/pull-requests/
64+
[3]: https://github.com/phpcq/coding-standard
65+
[4]: https://github.com/MetaModels/attribute_file/pull/new/master
66+
[5]: https://github.com/MetaModels/attribute_file/pull/new/develop

‎.github/ISSUE_TEMPLATE.md

+41
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,41 @@
1+
## Checklist before I submit this issue report
2+
3+
I confirm that:
4+
- [ ] I have tested this with the latest version available
5+
- [ ] I have read documentation @ http://metamodels.readthedocs.org/en/ or http://metamodels.readthedocs.org/de/
6+
- [ ] I have checked the Contao community forums for references https://community.contao.org/
7+
- [ ] I have checked existing issues for duplicates and found none @ https://github.com/MetaModels/attribute_file/issues?q=is%3Aissue
8+
9+
## My environment is:
10+
11+
(Please fill in the actual values from your environment)
12+
13+
| Key | Value | Comments |
14+
| ----------------------------------- | ---------| ---------------------------------|
15+
| PHP version: | | |
16+
| Contao version: | | |
17+
| MetaModels version: | | |
18+
| Installation via composer | (yes/no) | |
19+
| Installed MetaModels packages | | |
20+
21+
## Issue description
22+
23+
(Describe the problem you are having)
24+
25+
## Steps to reproduce
26+
27+
1. [First Step]
28+
2. [Second Step]
29+
3. [and so on…]
30+
31+
## Describe the behaviour of the application
32+
33+
(Tell us what happens)
34+
35+
## Describe the expected behaviour of the application
36+
37+
(Tell us what should have happened)
38+
39+
## Screenshots
40+
41+
(Add some visual love or even a video if you can)

‎.github/PULL_REQUEST_TEMPLATE.md

+12
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
## Description
2+
3+
Please explain the detailed changes you made here.
4+
Reference any issue number this pull request fixes.
5+
6+
## Checklist
7+
- [ ] Read and understood the [CONTRIBUTING guidelines](CONTRIBUTING.md)
8+
- [ ] Created tests, if possible
9+
- [ ] All tests passing
10+
- [ ] Extended the README / documentation, if necessary
11+
- [ ] Added myself to the `@authors` in touched PHP files
12+
- [ ] Checked the changes with phpcq and introduced no new issues

‎LICENSE

+165
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,165 @@
1+
GNU LESSER GENERAL PUBLIC LICENSE
2+
Version 3, 29 June 2007
3+
4+
Copyright (C) 2007 Free Software Foundation, Inc. <http://fsf.org/>
5+
Everyone is permitted to copy and distribute verbatim copies
6+
of this license document, but changing it is not allowed.
7+
8+
9+
This version of the GNU Lesser General Public License incorporates
10+
the terms and conditions of version 3 of the GNU General Public
11+
License, supplemented by the additional permissions listed below.
12+
13+
0. Additional Definitions.
14+
15+
As used herein, "this License" refers to version 3 of the GNU Lesser
16+
General Public License, and the "GNU GPL" refers to version 3 of the GNU
17+
General Public License.
18+
19+
"The Library" refers to a covered work governed by this License,
20+
other than an Application or a Combined Work as defined below.
21+
22+
An "Application" is any work that makes use of an interface provided
23+
by the Library, but which is not otherwise based on the Library.
24+
Defining a subclass of a class defined by the Library is deemed a mode
25+
of using an interface provided by the Library.
26+
27+
A "Combined Work" is a work produced by combining or linking an
28+
Application with the Library. The particular version of the Library
29+
with which the Combined Work was made is also called the "Linked
30+
Version".
31+
32+
The "Minimal Corresponding Source" for a Combined Work means the
33+
Corresponding Source for the Combined Work, excluding any source code
34+
for portions of the Combined Work that, considered in isolation, are
35+
based on the Application, and not on the Linked Version.
36+
37+
The "Corresponding Application Code" for a Combined Work means the
38+
object code and/or source code for the Application, including any data
39+
and utility programs needed for reproducing the Combined Work from the
40+
Application, but excluding the System Libraries of the Combined Work.
41+
42+
1. Exception to Section 3 of the GNU GPL.
43+
44+
You may convey a covered work under sections 3 and 4 of this License
45+
without being bound by section 3 of the GNU GPL.
46+
47+
2. Conveying Modified Versions.
48+
49+
If you modify a copy of the Library, and, in your modifications, a
50+
facility refers to a function or data to be supplied by an Application
51+
that uses the facility (other than as an argument passed when the
52+
facility is invoked), then you may convey a copy of the modified
53+
version:
54+
55+
a) under this License, provided that you make a good faith effort to
56+
ensure that, in the event an Application does not supply the
57+
function or data, the facility still operates, and performs
58+
whatever part of its purpose remains meaningful, or
59+
60+
b) under the GNU GPL, with none of the additional permissions of
61+
this License applicable to that copy.
62+
63+
3. Object Code Incorporating Material from Library Header Files.
64+
65+
The object code form of an Application may incorporate material from
66+
a header file that is part of the Library. You may convey such object
67+
code under terms of your choice, provided that, if the incorporated
68+
material is not limited to numerical parameters, data structure
69+
layouts and accessors, or small macros, inline functions and templates
70+
(ten or fewer lines in length), you do both of the following:
71+
72+
a) Give prominent notice with each copy of the object code that the
73+
Library is used in it and that the Library and its use are
74+
covered by this License.
75+
76+
b) Accompany the object code with a copy of the GNU GPL and this license
77+
document.
78+
79+
4. Combined Works.
80+
81+
You may convey a Combined Work under terms of your choice that,
82+
taken together, effectively do not restrict modification of the
83+
portions of the Library contained in the Combined Work and reverse
84+
engineering for debugging such modifications, if you also do each of
85+
the following:
86+
87+
a) Give prominent notice with each copy of the Combined Work that
88+
the Library is used in it and that the Library and its use are
89+
covered by this License.
90+
91+
b) Accompany the Combined Work with a copy of the GNU GPL and this license
92+
document.
93+
94+
c) For a Combined Work that displays copyright notices during
95+
execution, include the copyright notice for the Library among
96+
these notices, as well as a reference directing the user to the
97+
copies of the GNU GPL and this license document.
98+
99+
d) Do one of the following:
100+
101+
0) Convey the Minimal Corresponding Source under the terms of this
102+
License, and the Corresponding Application Code in a form
103+
suitable for, and under terms that permit, the user to
104+
recombine or relink the Application with a modified version of
105+
the Linked Version to produce a modified Combined Work, in the
106+
manner specified by section 6 of the GNU GPL for conveying
107+
Corresponding Source.
108+
109+
1) Use a suitable shared library mechanism for linking with the
110+
Library. A suitable mechanism is one that (a) uses at run time
111+
a copy of the Library already present on the user's computer
112+
system, and (b) will operate properly with a modified version
113+
of the Library that is interface-compatible with the Linked
114+
Version.
115+
116+
e) Provide Installation Information, but only if you would otherwise
117+
be required to provide such information under section 6 of the
118+
GNU GPL, and only to the extent that such information is
119+
necessary to install and execute a modified version of the
120+
Combined Work produced by recombining or relinking the
121+
Application with a modified version of the Linked Version. (If
122+
you use option 4d0, the Installation Information must accompany
123+
the Minimal Corresponding Source and Corresponding Application
124+
Code. If you use option 4d1, you must provide the Installation
125+
Information in the manner specified by section 6 of the GNU GPL
126+
for conveying Corresponding Source.)
127+
128+
5. Combined Libraries.
129+
130+
You may place library facilities that are a work based on the
131+
Library side by side in a single library together with other library
132+
facilities that are not Applications and are not covered by this
133+
License, and convey such a combined library under terms of your
134+
choice, if you do both of the following:
135+
136+
a) Accompany the combined library with a copy of the same work based
137+
on the Library, uncombined with any other library facilities,
138+
conveyed under the terms of this License.
139+
140+
b) Give prominent notice with the combined library that part of it
141+
is a work based on the Library, and explaining where to find the
142+
accompanying uncombined form of the same work.
143+
144+
6. Revised Versions of the GNU Lesser General Public License.
145+
146+
The Free Software Foundation may publish revised and/or new versions
147+
of the GNU Lesser General Public License from time to time. Such new
148+
versions will be similar in spirit to the present version, but may
149+
differ in detail to address new problems or concerns.
150+
151+
Each version is given a distinguishing version number. If the
152+
Library as you received it specifies that a certain numbered version
153+
of the GNU Lesser General Public License "or any later version"
154+
applies to it, you have the option of following the terms and
155+
conditions either of that published version or of any later version
156+
published by the Free Software Foundation. If the Library as you
157+
received it does not specify a version number of the GNU Lesser
158+
General Public License, you may choose any version of the GNU Lesser
159+
General Public License ever published by the Free Software Foundation.
160+
161+
If the Library as you received it specifies that a proxy can decide
162+
whether future versions of the GNU Lesser General Public License shall
163+
apply, that proxy's public statement of acceptance of any version is
164+
permanent authorization for you to choose that version for the
165+
Library.

0 commit comments

Comments
 (0)