Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
25 lines (19 loc) · 1.93 KB

CONTRIBUTING.md

File metadata and controls

25 lines (19 loc) · 1.93 KB

Contributing to Codeceptjs-BDD

First, I'd like to thank you for wanting to contribute and make the CodeceptJS Acceptance BDD Automation Framework experience better for the community. 👍🎉 -- @gkushang

If you'd like to contribute, please make sure to discuss the intended changes either by creating a new Issue or commenting on existing one.

Submit the PR for new Feature or Bug fixes

  1. Fork this repository (button in upper right). Install git and clone your fork locally with git clone git@github.com:[YOUR-USER]/codeceptjs-bdd.git. This library only supports use of git-bash in Windows. The default command prompt may not work.
  2. Create a topic branch locally such as feature/support-visual-testing for new Feature or bugfix/saucelabs-api for Bug fixes.
  3. Install Lerna globally.
  4. Install Node and YARN.
  5. cd codepceptjs-bdd and run lerna bootstrap to install dependencies.
  6. Make your changes locally and commit to your Forked git repository
  7. Create a PR to the origin codeceptjs-bdd develop branch.
  8. Once your changes are approved in develop branch, it will be released within few days.

Contributing Guidelines

  • Explain your changes in the PR description, that could be new feature or bug fixes
  • Follow the coding standard
  • Format your code with default ES Lint of your editor
  • If you are making a change in the SauceLabs integration, make changes under codepcetjs-bdd/packages/codeceptjs-saucelabs
  • If you are making a change in the CodeceptJs Configuration, make changes under codepcetjs-bdd/packages/codeceptjs-configure
  • If you are making a change in the CodeceptJs Cucumber framework, make changes under codepcetjs-bdd/packages/codeceptjs-cucumber