Contributors



I urge everyone to contribute to the project. You can find the latest version of the code on GitHub at https://github.com/orchidsoftware/platform.

Problem tracking

You can find unresolved issues on GitHub Issues Tracker.  If you intend to work on a specific issue, leave a comment on the relevant task to inform other project participants.

For active development, it is strongly recommended that you use only pull request requests, not just bug reports.

If you created a bug report, then it should contain a title and a clear description of the problem. You should also include as complete information and sample code as possible to help reproduce the problem. The main goal of the bug report is to simplify the localization, reproduction of the problem and search for its solution.

Also remember that error reports are created in the hope that other users with the same problems will be able to participate in solving them together with you. But do not expect others to quit and start fixing your problem. The bug report is designed to help you and others start working together to resolve a problem.

Participate in discussions

You can offer new features and enhancements to your existing ORCHID behavior. If you are proposing a new function, please be prepared to execute at least the code examples that will be needed to call / use this function.

Informal discussion about bugs / problems and new features:

  1. Telegram group @orchid_community
  2. Telegram group @orchid_russian_community

Security

If you find a security vulnerability inside the platform, please send an e-mail message to bliz48rus@gmail.com. All appeals will be immediately considered.

Coding style

ORCHID follows PSR-2 and PSR-4 standards.

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

To get started, install the tool on a global level and check the code style by executing the following command from the terminal of the root directory of your project:

php-cs-fixer fix

Debug and submit change request

At the stage of helping the project, questions may arise related to debugging and installation, This section is designed for those who want to send a request for the first time.

Development Installation

To install the ORCHID package as a developer, you must install the laravel framework.

First you have to make a fork github repository to post changes.

Go to the directory and execute:

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

Add a local repository to the composer.json application:

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

And add our package depending:

composer require orchid/platform:@dev

Composer add the package from the repository that you specified. The remaining actions correspond to the section Installations.

Submit change request

Create a new branch like this:

git checkout -b feature/issue_001

This will allow you to almost immediately understand that the created branch adds new functionality from the message number 001.

Make changes and commit them:

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

To send your branch you need to do:

git push origin feature/issue_001