Index.rst 1.92 KB
Newer Older
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
.. include:: ../Includes.txt


.. _contribute:

==========
Contribute
==========

Do you want people to contribute to your extension?

Here, you can add information about conventions you use when developing.
You may want to base this on already existing conventions for the TYPO3
core and for TYPO3 documentation.

If your project is hosted on GitHub, it is a good idea to add a file:`CONTRIBUTING.rst`
file. This sample template manual has one. A link to that file will automatically
be displayed by GitHub if people enter the issues section of your project for the first time
or create an issue.

The file:`CONTRIBUTING.rst` will not be displayed, when your extension is rendered on
docs.typo3.org though (because file:`CONTRIBUTING.rst` is outside of the scope of
the file:`Documentation` folder).

So, as not to create duplicate information, either use this file as main information
source about contributing and link to this page from file:`CONTRIBUTING.rst` or the other
way around.

**Sample text follows ...**

Contribution to this extension is very welcome.

If you wish to contribute, please follow these conventions:

Writing Issues
==============

* If you find a problem in the extension, please write an issue.
* If you can fix the problem yourself, please submit a pull request. In this
  case, it is not necessary to create an issue first.

Submitting a Pull Request
=========================

* Please adhere to `TYPO3 Coding Guidelines
  <https://docs.typo3.org/typo3cms/CoreApiReference/CodingGuidelines/Index.html>`__
* For commit messages, please follow the `TYPO3 Commit Message Rules
  <https://docs.typo3.org/typo3cms/ContributionWorkflowGuide/Appendix/CommitMessage.html>`__


Please see the general GitHub documentation for more information, for example
`Creating a pull request <https://help.github.com/articles/creating-a-pull-request/>`__

Donate
======

Here, you can add a link to how people can support you and donate for your extension.