Skip to content

Latest commit

 

History

History
77 lines (41 loc) · 3.37 KB

CONTRIBUTING.md

File metadata and controls

77 lines (41 loc) · 3.37 KB
Raw

Contributing to Cognizant CXOptimize

These are just guidelines, not rules. Use your best judgment. Please feel free to propose changes to this document in a pull request.

Code of Conduct

This project adheres to the Contributor Covenant code of conduct. By participating, you are expected to uphold this code. Please report unacceptable behavior to CogCITS@cognizant.com.

Communication

For general queries and discussions, please use the Cognizant CXOptimize Forum on Google Groups

How Can I Contribute?

Sign the CLA

Before you contribute, we first ask people to sign a Contributor License Agreement (or CLA). We ask this so that we know that contributors have the right to donate the code.

When you open your pull request we ask that you indicate that you've signed the CLA. This will reduce the time it takes for us to integrate it.

Reporting Bugs

  • Please go through the Help section to see if the problem is already addressed. Most common problems are already addressed in Troubleshooting and FAQs sections.

  • Perform a cursory search to see if the problem has already been reported. If it has, add a comment to the existing issue instead of opening a new one.

  • Use a clear and descriptive title for the issue to identify the problem.

  • Describe your environment - OS Version, Java version, Browsers used and their versions etc.

  • Describe the behavior you observed after following the steps and point out what exactly is the problem with that behavior.

  • Do check if it is an issue with the third party libraries used. For example Web-Execution and Element Finding issues could be mostly related to Selenium. We will not be able to support issues related to third party libraries.

  • If the issues are related to execution attach the console.txt and reports if possible.

  • If you are facing any issue with the UI attach screenshots and log.txt present in the installation location.

  • Please report Addon/Extension related issues to their respective Github Repos.

Suggesting Enhancements

  • Perform a cursory search to see if the enhancement has already been suggested. If it has, add a comment to the existing issue instead of opening a new one.

  • Use a clear and descriptive title for the issue to identify the suggestion

  • Explain why this enhancement would be useful to most Cognizant Intelligent Test Scripter users and isn't something that can or should be implemented as a community package

Code Contribution

JDK 1.8

Gradle 3.1 or greater

Any Java IDE of your choice. We have used Intellij for development

Setup the dependencies

gradlew clean build

The Release will be created in build folder. You can test using the files inside build/libs folder.

If you want to debug/run from source code. You have to run the IDE project.

Submiting Changes

Always write a clear log message for your commits. One-line messages are fine for small changes, but bigger changes should look like this:

$ git commit -m "A brief summary of the commit
>
> A paragraph describing what changed and its impact."