Skip to content

Latest commit

 

History

History
54 lines (37 loc) · 2.62 KB

CONTRIBUTING.md

File metadata and controls

54 lines (37 loc) · 2.62 KB
Raw

Contributing

JIRA REST API Client is an open source, community-driven project. If you'd like to contribute, feel free to do this, but remember to follow these few simple rules:

Submitting an issues

  • A reproducible example is required for every bug report, otherwise it will most probably be closed without warning.
  • If you are going to make a big, substantial change, let's discuss it first.

Working with Pull Requests

  1. Create your feature addition or a bug fix branch based on master branch in your repository's fork.
  2. Make necessary changes, but don't mix code reformatting with code changes on topic.
  3. Add entry in CHANGELOG.md file following https://keepachangelog.com/en/1.0.0/ format (if applicable).
  4. Add tests for those changes (please look into tests/ folder for some examples). This is important so we don't break it in a future version unintentionally.
  5. Check your code using "Coding Standard" (see below).
  6. Commit your code.
  7. Squash your commits by topic to preserve a clean and readable log.
  8. Create Pull Request.

Running the Tests

OPTIONAL: Configuration for Integration Tests

The repository term used below refers to your clone of current project GitHub repository fork and not JIRA instance.

To be able to run integration tests locally please follow these steps once:

  1. make sure repository is located in web server document root (or it's sub-folder)
  2. copy phpunit.xml.dist file into phpunit.xml file
  3. in the phpunit.xml file:
  • uncomment part, where REPO_URL environment variable is defined
  • set REPO_URL environment variable value to URL, from where repository can be accessed (e.g. http://localhost/path/to/repository/[:<portNumber>])

Before running tests, change directory to the root of your repository and run php -S localhost:<portNumber>

Then run the unit tests as per normal.

N.B. you can study the .travis.yml file to see how we run these tests on our build servers by way of example.

Running Test Suite

Make sure that you don't break anything with your changes by running:

$> vendor/bin/phpunit

Checking coding standard violations

This library uses Coding Standard to ensure consistent formatting across the code base. Make sure you haven't introduced any Coding Standard violations by running following command in the root folder of the library:

$> vendor/bin/phpcs --standard="vendor/aik099/coding-standard/CodingStandard" src tests

or by making your IDE (instructions for PhpStorm) to check them automatically.