mirror of
https://github.com/Sylius/Sylius.git
synced 2026-07-14 09:02:12 +00:00
contributing part, based on symfony.com docs.
This commit is contained in:
parent
2d01407fd2
commit
6be273e8b2
7 changed files with 140 additions and 0 deletions
2
bundles-architecture-concepts.rst
Normal file
2
bundles-architecture-concepts.rst
Normal file
|
|
@ -0,0 +1,2 @@
|
||||||
|
Bundles architecture concepts.
|
||||||
|
==============================
|
||||||
26
contributing/code/bugs.rst
Normal file
26
contributing/code/bugs.rst
Normal file
|
|
@ -0,0 +1,26 @@
|
||||||
|
Reporting a bug
|
||||||
|
===============
|
||||||
|
|
||||||
|
All bundles and Sylius itself, uses **GitHub issues** for bug tracking.
|
||||||
|
If you have found a bug, please create an issue for correct repository.
|
||||||
|
|
||||||
|
Before submitting a bug:
|
||||||
|
|
||||||
|
* Double-check the official `documentation <http://sylius.org/docs/index.html>`_ to see if you're not misusing the
|
||||||
|
bundle or Sylius;
|
||||||
|
|
||||||
|
* Ask for assistance on the `users mailing list <http://groups.google.com/group/sylius>`_, or on the
|
||||||
|
#sylius `IRC channel <irc://irc.freenode.net/sylius>`_ if you're not sure if your issue is really a bug.
|
||||||
|
|
||||||
|
If your problem definitely looks like a bug, report it using the **GitHub** issues.
|
||||||
|
|
||||||
|
* Use the title field to clearly describe the issue;
|
||||||
|
|
||||||
|
* Describe the steps needed to reproduce the bug with short code examples
|
||||||
|
(providing a unit test that illustrates the bug is best);
|
||||||
|
|
||||||
|
* Give as much details as possible about your environment (OS, PHP version,
|
||||||
|
Symfony version, Sylius version, enabled extensions, ...);
|
||||||
|
|
||||||
|
* *(optional)* Attach a :doc:`patch <patches>`.
|
||||||
|
|
||||||
29
contributing/code/license.rst
Normal file
29
contributing/code/license.rst
Normal file
|
|
@ -0,0 +1,29 @@
|
||||||
|
Sylius license
|
||||||
|
==============
|
||||||
|
|
||||||
|
Sylius is released under the MIT license.
|
||||||
|
|
||||||
|
The License
|
||||||
|
-----------
|
||||||
|
|
||||||
|
Copyright (c) 2011-2012 Paweł Jędrzejewski
|
||||||
|
|
||||||
|
Permission is hereby granted, free of charge, to any person obtaining a copy
|
||||||
|
of this software and associated documentation files (the "Software"), to deal
|
||||||
|
in the Software without restriction, including without limitation the rights
|
||||||
|
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
||||||
|
copies of the Software, and to permit persons to whom the Software is furnished
|
||||||
|
to do so, subject to the following conditions:
|
||||||
|
|
||||||
|
The above copyright notice and this permission notice shall be included in all
|
||||||
|
copies or substantial portions of the Software.
|
||||||
|
|
||||||
|
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
||||||
|
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
||||||
|
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
||||||
|
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
||||||
|
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
||||||
|
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
|
||||||
|
THE SOFTWARE.
|
||||||
|
|
||||||
|
.. _Wikipedia: http://en.wikipedia.org/wiki/MIT_License
|
||||||
8
contributing/code/patches.rst
Normal file
8
contributing/code/patches.rst
Normal file
|
|
@ -0,0 +1,8 @@
|
||||||
|
Submitting a patch
|
||||||
|
==================
|
||||||
|
|
||||||
|
There is no purpose on rewritting `this <http://symfony.com/doc/current/contributing/code/patches.html>`_.
|
||||||
|
|
||||||
|
It's just perfect check list so please follow it, while creating patch for Sylius.
|
||||||
|
|
||||||
|
The only difference is that instead of tagging pull requests with *[Component]*, just send the pull request to correct repository.
|
||||||
50
contributing/documentation/license.rst
Normal file
50
contributing/documentation/license.rst
Normal file
|
|
@ -0,0 +1,50 @@
|
||||||
|
Sylius documentation license
|
||||||
|
============================
|
||||||
|
|
||||||
|
The Sylius documentation is licensed under a Creative Commons
|
||||||
|
Attribution-Share Alike 3.0 Unported `License`_.
|
||||||
|
|
||||||
|
**You are free:**
|
||||||
|
|
||||||
|
* to *Share* — to copy, distribute and transmit the work;
|
||||||
|
|
||||||
|
* to *Remix* — to adapt the work.
|
||||||
|
|
||||||
|
**Under the following conditions:**
|
||||||
|
|
||||||
|
* *Attribution* — You must attribute the work in the manner specified by
|
||||||
|
the author or licensor (but not in any way that suggests that they
|
||||||
|
endorse you or your use of the work);
|
||||||
|
|
||||||
|
* *Share Alike* — If you alter, transform, or build upon this work, you
|
||||||
|
may distribute the resulting work only under the same or similar license
|
||||||
|
to this one.
|
||||||
|
|
||||||
|
**With the understanding that:**
|
||||||
|
|
||||||
|
* *Waiver* — Any of the above conditions can be waived if you get
|
||||||
|
permission from the copyright holder;
|
||||||
|
|
||||||
|
* *Public Domain* — Where the work or any of its elements is in the public
|
||||||
|
domain under applicable law, that status is in no way affected by the
|
||||||
|
license;
|
||||||
|
|
||||||
|
* *Other Rights* — In no way are any of the following rights affected by the
|
||||||
|
license:
|
||||||
|
|
||||||
|
* Your fair dealing or fair use rights, or other applicable copyright
|
||||||
|
exceptions and limitations;
|
||||||
|
|
||||||
|
* The author's moral rights;
|
||||||
|
|
||||||
|
* Rights other persons may have either in the work itself or in how
|
||||||
|
the work is used, such as publicity or privacy rights.
|
||||||
|
|
||||||
|
* *Notice* — For any reuse or distribution, you must make clear to others
|
||||||
|
the license terms of this work. The best way to do this is with a link
|
||||||
|
to this web page.
|
||||||
|
|
||||||
|
This is a human-readable summary of the `Legal Code (the full license)`_.
|
||||||
|
|
||||||
|
.. _License: http://creativecommons.org/licenses/by-sa/3.0/
|
||||||
|
.. _Legal Code (the full license): http://creativecommons.org/licenses/by-sa/3.0/legalcode
|
||||||
17
contributing/index.rst
Normal file
17
contributing/index.rst
Normal file
|
|
@ -0,0 +1,17 @@
|
||||||
|
Contributing
|
||||||
|
============
|
||||||
|
|
||||||
|
This part of documentation is based on the great `Symfony2 documentation <http://symfony.com/doc/current>`_.
|
||||||
|
|
||||||
|
* **Code**:
|
||||||
|
|
||||||
|
* :doc:`Bugs </contributing/code/bugs>`
|
||||||
|
* :doc:`Patches </contributing/code/patches>`
|
||||||
|
* `Coding Standards <http://symfony.com/doc/current/contributing/code/standards.html>`_
|
||||||
|
* `Code Conventions <http://symfony.com/doc/current/contributing/code/conventions.html>`_
|
||||||
|
* :doc:`License </contributing/code/license>`
|
||||||
|
|
||||||
|
* **Documentation**:
|
||||||
|
|
||||||
|
* :doc:`License </contributing/documentation/license>`
|
||||||
|
|
||||||
|
|
@ -3,6 +3,14 @@ Welcome
|
||||||
|
|
||||||
Welcome to the official `Sylius project <http://sylius.org>`_ documentation.
|
Welcome to the official `Sylius project <http://sylius.org>`_ documentation.
|
||||||
|
|
||||||
|
Project
|
||||||
|
-------
|
||||||
|
|
||||||
|
.. toctree::
|
||||||
|
:maxdepth: 0
|
||||||
|
|
||||||
|
contributing/index
|
||||||
|
|
||||||
Bundles reference
|
Bundles reference
|
||||||
-----------------
|
-----------------
|
||||||
|
|
||||||
|
|
|
||||||
Loading…
Add table
Reference in a new issue