Skip to content

Latest commit

 

History

History
53 lines (37 loc) · 3.18 KB

CONTRIBUTING.md

File metadata and controls

53 lines (37 loc) · 3.18 KB
Raw

Contributing Guidelines

Your contributions are always welcome! There are a number of ways you can contribute. These guidelines instruct how to submit issues and contribute code or documentation to Qxf2 Automation Framework.

Reporting bugs

This section guides you through submitting a bug report for Qxf2. Before submitting a new issue, it is always a good idea to check if the same bug or enhancement is already reported. If it is, please add your comments to the existing issue instead of creating a new one. Bugs are tracked as GitHub issues. After you've determined which repository your bug is related to, create an issue on that repository and provide the following information:

  • Use a clear and descriptive title for the issue to identify the problem
  • Explain the steps to reproduce so that others can understand it and and preferably also reproduce it
  • Provide snippets to demonstrate the steps which you might think is causing the bug
  • Expected result
  • Actual results
  • Environment details: Operating system and its version, packages installed

Enhancement requests

Enhancement suggestions are tracked as GitHub issues. Enhancements can be anything including completely new features and minor improvements to existing functionality. After you've determined which repository your enhancement suggestion is related to, create an issue on that repository and provide the following information:

  • 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.
  • Provide specific examples to demonstrate the steps.
  • Describe the current behavior and describe which behavior you expected to see instead and why.
  • Include screenshots or animated GIF's which help you demonstrate the steps or point out the part of framework which the suggestion is related to.
  • Explain how and why this enhancement would be useful
  • Specify the name and version of the OS you're using.
  • Specify the browser version you're using.
  • Describe the new feature and use cases for it in as much detail as possible

Code Contributions

This part of the document will guide you through the contribution process. If you have fixed a bug or implemented an enhancement, you can contribute your changes via GitHub's Pull requests. If this is your first time contributing to a project via GitHub follow below guidelines

Here is the basic workflow:

  1. Fork the Qxf2 repo. You can do this via the GitHub website. By doing this, you will have a local copy of the qxf2 repo under your Github account.
  2. Clone the Qxf2 repo to your local machine
  3. Create a feature branch and start hacking
  4. Commit the changes on that branch
  5. Push your change to your repo
  6. Bug fixes and features should have tests. Before you submit your pull request make sure you pass all the tests.
  7. Use the github UI to open a PR
  8. When code review is complete, a committer will take your PR and merge it on our master branch.