-
Notifications
You must be signed in to change notification settings - Fork 88
Contribution Guide
aivaturi edited this page Mar 7, 2012
·
6 revisions
Thank you very much for considering contributing to this project. We have lot of work that needs to be done & since Selenium project itself evolves rapidly with changing web technologies, there is always something to do. But to streamline this process, we'd really appreciate if you follow these simple guidelines.
For code changes:
- Fork the repo, create a feature branch & name that feature branch appropriately. For e.g. if you are going to add rotation support for iphone, name the branch something like "iphone-rotation". Please do not make changes in your master branch & submit that for pull request. Make all your changes in that work branch & get it up-to-date with the upstream before you submit a pull request.
- Please write unit tests for the code that you're adding or modifying. You don't have to create new mock recordings. Also make sure all the unit tests pass with live server before creating a pull request. The first thing we will do is run against our existing unit tests & they need to pass, otherwise we will simply reject the pull request until you fix the code.
- Also, please update the relevant POD for the changes you're making.
For documentation changes:
- Please follow the existing structure that we use. For every method, please include proper Description, Input, Output and Usage (example code).