Skip to content
This repository has been archived by the owner on Dec 30, 2022. It is now read-only.

Latest commit

 

History

History
186 lines (126 loc) · 6.25 KB

CONTRIBUTING.md

File metadata and controls

186 lines (126 loc) · 6.25 KB
Raw

CONTRIBUTING

Resources

If you wish to contribute to Adroit, please be sure to read/subscribe to the following resources:

If you are working on new features or refactoring create a proposal.

Reporting Potential Security Issues

If you have encountered a potential security vulnerability, please DO NOT report it on the public issue tracker: send it to us at [email protected] instead. We will work with you to verify the vulnerability and patch it as soon as possible.

When reporting issues, please provide the following information:

  • Component(s) affected
  • A description indicating how to reproduce the issue
  • A summary of the security vulnerability and impact

We request that you contact us via the email address above and give the project contributors a chance to resolve the vulnerability and issue a new release prior to any public exposure. This helps protect users and provides them with a chance to upgrade and/or update in order to protect their applications.

For sensitive email communications, please use our PGP key.

Running Tests

To run tests:

  1. Clone the repository:
$ git clone [email protected]:bitExpert/adroit.git
$ cd adroit
  1. Install dependencies via composer:
$ ./composer.phar install

If you don't have curl installed, you can also download composer.phar from https://getcomposer.org/download/

  1. Run the tests using the "test" command shipped in the composer.json:
$ composer test

You can turn on conditional tests with the phpunit.xml file. To do so:

  • Copy phpunit.xml.dist file to phpunit.xml
  • Edit phpunit.xml to enable any specific functionality you want to test, as well as to provide test values to utilize.

Running Coding Standards Checks

First, ensure you've installed dependencies via composer, per the previous section on running tests. To run CS checks only:

$ composer cs-check

To attempt to automatically fix common CS issues:

$ composer cs-fix

If the above fixes any CS issues, please re-run the tests to ensure they pass, and make sure you add and commit the changes after verification.

Recommended Workflow for Contributions

Your first step is to establish a public repository from which we can pull your work into the master repository. We recommend using GitHub, as that is where the component is already hosted.

  1. Setup a GitHub account, if you haven't yet
  2. Fork the repository (http://github.com/bitExpert/adroit)
  3. Clone the canonical repository locally and enter it.
$ git clone git://github.com:bitExpert/adroit.git
$ cd adroit
  1. Add a remote to your fork; substitute your GitHub username in the command below.
$ git remote add {username} [email protected]:{username}/adroit.git
$ git fetch {username}

Keeping Up-to-Date

Periodically, you should update your fork or personal repository to match the canonical Adroit repository. Assuming you have setup your local repository per the instructions above, you can do the following:

$ git checkout master
$ git fetch origin
$ git rebase origin/master
# OPTIONALLY, to keep your remote up-to-date -
$ git push {username} master:master

If you're tracking other branches you'll want to do the same operations for those branches; simply substitute the branch names for "master".

Working on a patch

We recommend you do each new feature or bugfix in a new branch. This simplifies the task of code review as well as the task of merging your changes into the canonical repository.

A typical workflow will then consist of the following:

  1. Create a new local branch based off your master branch.
  2. Switch to your new local branch. (This step can be combined with the previous step with the use of git checkout -b.)
  3. Do some work, commit, repeat as necessary.
  4. Push the local branch to your remote repository.
  5. Send a pull request.

The mechanics of this process are actually quite trivial. Below, we will create a branch for fixing an issue in the tracker.

$ git checkout -b hotfix/9295
Switched to a new branch 'hotfix/9295'

...do some work...

$ git commit

...write your log message...

$ git push {username} hotfix/9295:hotfix/9295
Counting objects: 38, done.
Delta compression using up to 2 threads.
Compression objects: 100% (18/18), done.
Writing objects: 100% (20/20), 8.19KiB, done.
Total 20 (delta 12), reused 0 (delta 0)
To ssh://[email protected]/{username}/adroit.git
   b5583aa..4f51698  HEAD -> master

### Sending a PR

Before sending a PR, run composer.phar validate && composer.phar check, as the Travis build will also run the command and will fail if the composer.lock file is not up-to-date with the changes in the composer.json file.

When you’ve done that, and you’re reading to send one, you have two options:

  1. If using GitHub, you can do the pull request from there. Navigate to your repository, select the branch you just created, and then select the "Pull Request" button in the upper right. Select the user/organization "bitExpert" as the recipient.

  2. If using your own repository - or even if using GitHub - you can use git format-patch to create a patchset for us to apply; in fact, this is recommended for security-related patches.

What Branch to Issue the Pull Request Against?

Which branch should you issue a pull request against?

  • For fixes against the stable release, issue the pull request against the latest release branch.
  • For new features, or fixes that introduce new elements to the public API (such as new public methods or properties), issue the pull request against the "master" branch.

Branch Cleanup

As you might imagine, if you are a frequent contributor, you'll start to get a ton of branches both locally and on your remote. Once you know that your changes have been accepted to the master repository, we suggest doing some cleanup of these branches.

  • Local branch cleanup
$ git branch -d <branchname>
  • Remote branch removal
$ git push {username} :<branchname>