CONTRIBUTING.md

Contributing

Help us to make this project better by contributing. Whether it's new features, bug fixes, or simply improving documentation, your contributions are welcome. Please start with logging a github issue or submit a pull request.

Before you contribute, please review these guidelines to help ensure a smooth process for everyone.

Thanks.

Issue Reporting

• Please browse our existing issues before logging new issues.
• Check that the issue has not already been fixed in the master branch.
• Open an issue with a descriptive title and a summary.
• Please be as clear and explicit as you can in your description of the problem.
• Please state the version of {technical dependencies} and inspec_delta you are using in the description.
• Include any relevant code in the issue summary.

Pull Requests

• Read how to properly contribute to open source projects on Github.
• Fork the project.
• Use a feature branch.
• Write good commit messages.
• Use the same coding conventions as the rest of the project.
• Commit locally and push to your fork until you are happy with your contribution.
• Make sure to add tests and verify all the tests are passing when merging upstream.
• Add an entry to the Changelog accordingly.
• Please add your name to the CONTRIBUTORS.md file. Adding your name to the CONTRIBUTORS.md file signifies agreement to all rights and reservations provided by the License.
• Squash related commits together.
• Open a pull request.
• The pull request will be reviewed by the community and merged by the project committers.

Dependencies

• Gems:
  • [facets] (https://github.com/rubyworks/facets)
  • [inspec-objects] (https://github.com/inspec/inspec-objects)
  • [inspec-tools] (https://github.com/mitre/inspec_tools)
  • rubocop
  • [ruby2ruby] (https://github.com/seattlerb/ruby2ruby)
  • [ruby_parser] (https://github.com/seattlerb/ruby_parser)
  • thor

Installation (Window Platform)

For development and testing in window, please follow below steps after installation,

1. Download rubyinstaller and DevKit from this link rubyinstaller. Please make sure you download appropriate versions for your operating system.
2. Follow below commands

  Extract DevKit to path C:{ruby-installation-folder}\DevKit
  > cd C:{ruby-installation-folder}\DevKit

  > ruby dk.rb init

  > ruby dk.rb review

  > ruby dk.rb install

  > gem install json --platform=ruby

Development and Testing

After performing installation(ruby) steps described on readme, perform below steps for development.

Linux & Window

  > bundle exec rspec   # Generates  directory "coverage" with unit test report

  > rake rubocop    # Generates directory "lint_report"

  > gem build inspec_delta.gemspec   # Builds the gem for project

  > gem install inspec_delta(-version).gem    # Installs inspec_delta gem on computer.

  > inspec_delta    # Runs gem