mirror/Arsse
1
1
Fork 0
mirror of https://code.mensbeam.com/MensBeam/Arsse.git synced 2024-12-22 21:22:40 +00:00
Code Issues Activity
Arsse/CONTRIBUTING.md
J. King 1e0c06034b Documentation for 0.2.0; fixes #108
2017-11-29 20:23:04 -05:00

2.9 KiB
Raw Blame History

Contributing to The Arsse

We would love for you to contribute to our little project and to make The Arsse better. Here are the guidelines we would like you to follow:

Code of Conduct

We strive to keep The Arsse open and inclusive. Please read our Code of Conduct and follow its guidelines when interacting with others within this community.

Questions, Bugs & Feature Requests

Questions about how to use The Arsse, bugs, or feature requests can be directed at the issues page.

Submission Guidelines

Submitting an issue

Before you submit your issue search the archive to see if your question has been answered for you already. If your issue is new and hasn't been reported open a new issue; please do not report duplicate issues. We would like for you to provide the following information with each issue as it helps us help you:

  1. Overview – Always submit stack traces if the bug produces one.
  2. Versions – What version of The Arsse, php, and operating system are you using?
  3. Reproduce - Provide a set of steps to reproduce the issue.
  4. Related - Provide any issues you think might be related.
  5. Suggestions - If you cannot fix the bug yourself provide any suggestions for fixing the issue.

Submitting a Pull Request

Before you submit your pull request search for an existing open or closed pull request. Please refrain from duplicating pull requests.

Coding Rules

We would like to ensure consistency in our source code, so we follow the PSR-2 guidelines with one notable exception (utilizing the notation used and outlined in the original document):

Opening braces for classes and methods MUST go on the same line, and closing braces MUST go on the next line after the body.

Running tests

To run the test suite, you must have Composer installed as well as the command-line PHP interpreter (this is normally required to use Composer). Port 8000 must also be available for use by the built-in PHP Web server.

# first install dependencies
php composer.phar install
# run the tests
./tests/test

The example uses Unix syntax, but the test suite also runs in Windows. By default all tests are run; you can pass the same arguments to the test runner as you would to PHPUnit

./tests/test --testsuite "Configuration"