Participation in development



I appeal to everyone to make a contribution to the ORCHID project. You can find the latest version of the source code at GitHub by https://github.com/orchidsoftware/platform.

Problem tracking

You can find outstanding issues on GitHub Issues Tracker. If you are going to work on a specific question, please leave a comment on the appropriate task to inform the other project participants.

For active development it is strongly recommended to use pull requests only, instead of bug reports.

A bug report must contain title and a clear account of a problem. You must also include the information as detailed as possible and the code sample that would help in problem reproducing. The main objective of a bug report is to simplify tracing and reproducing of the problem and search for its solution.

As a reminder, bug reports are designed to let the other users with the same problem have a say in the matter. But it does not mean that the others will rush to your aid. A bug report is intended to help you and other users to start collaboration in problem solving.

Participation in main discussions

You can offer new functions and enhancements of the ORCHID's current entity. If you offer a new function, you should be ready to run at least the code samples required for a call/use of the function.

Non-formal discussions concerning bugs/problems and new possibilities:

  1. Telegram group @orchid_community
  2. Slack group ORCHID

Security

If you have detected vulnerability within ORCHID, please send an email at bliz48rus@gmail.com. All the appeals will be considered immediately.

Code writing style

ORCHID follows PSR-2 and PSR-4 standards.

You can use PHP-CS-Fixer, to correct your code style before publishing.

To start, install the tool globally and check the code style by running the following command from the root directory terminal of your project:

php-cs-fixer fix

Debug and sending a pull request.

This section is made for those who want to send a request for the first time if there are questions about debug and install.

Install

To install the ORCHID package as a developer, laravel framework installation is necessary.

Go to folder and run:

git clone https://github.com/orchidsoftware/platform.git

Add the local repository at composer.json of the application:

"repositories": [
    {
        "type": "path",
        "url": "./platform"
    }
]

And add our package in dependence:

composer require orchid/platform:@dev

Composer will install the package from the storage you have chosen. The other actions are according to the Installation section.

Sending a pull request

Create a new branch as an example:

git checkout -b feature/issue_001

This will let you understand that the created branch adds a new functionality from the message number 001.

Make changes and fix them:

git commit -am 'ref #001 [Docs] Fix misprint'

To send your branch run the following:

git push origin feature/issue_001