Skip to content

Latest commit

 

History

History
82 lines (49 loc) · 2.91 KB

CONTRIBUTING.md

File metadata and controls

82 lines (49 loc) · 2.91 KB
Raw

Contributing to TShield

First of all, thanks for taking time to contribuite!

The following is a set of guidelines for contributing to TShield. Feel free to propose changes to this document in a pull request.

Table of Contents

Code of Conduct

This project and everyone participating in it is governed by the project Code of Conduct.

Submit Enhancement Suggestion

Enhancement suggestions are tracked as GitHub issues. So, if you want to suggest an enhancement create an issue on this repository, following the below instructions

  • Use a clear and descriptive title for the issue to identify the suggestion.
  • Provide a step-by-step description of the suggested enhancement in as many details as possible.
  • Describe the current behavior and explain which behavior you expected to see instead and why.
  • Explain why this enhancement would be useful to most TShield users.
  • List some other API mocks or applications where this enhancement exists.
  • Specify which version of TShield you're using.
  • Specify the name and version of the OS you're using.

Local development

###First install dependencies. We recommend use of the RVM to manage project dependencies.

bundle install

###Run server to development

To start server execute:

rake server

###Build

To generate ruby gem execute:

rake build

###Test

To run all unit tests:

rake spec

To run all component tests:

rake component_tests

Pull Requests

The process described here has several goals:

  • Maintain TShield quality
  • Fix problems that are important to users
  • Add improvements or new features

Please follow these steps to have your contribution considered by the maintainers:

  1. Follow the styleguides
  2. After you submit your pull request, verify that all status checks are passing
    What if the status checks are failing?If a status check is failing, and you believe that the failure is unrelated to your change, please leave a comment on the pull request explaining why you believe the failure is unrelated. A maintainer will re-run the status check for you. If we conclude that the failure was a false positive, then we will open an issue to track that problem with our status check suite.
  3. Create automated behavior tests (acceptance tests)

While the prerequisites above must be satisfied prior to having your pull request reviewed, the reviewer(s) may ask you to complete additional design work, tests, or other changes before your pull request can be ultimately accepted.

Styleguides

  • TBD