Skip to content

Latest commit

 

History

History
84 lines (59 loc) · 4.57 KB

CONTRIBUTING.md

File metadata and controls

84 lines (59 loc) · 4.57 KB
Raw

Contributing

Thank you for your interest and for taking the time to contribute to this project. If you feel insecure about how to start contributing, feel free to ask us on our Discord Server in the #open-source channel.

Code of conduct

Read our Code of Conduct before contributing.

How can I contribute?

There are many ways in which you can contribute to this repository.

👥 Join the community

  Join our Discord server.

🐞 Report a bug

  Report all issues through GitHub Issues and provide as much information as you can.

🛠 Create a feature request

  We welcome all feature requests, whether for new features or enhancements to existing features. File your feature request through GitHub Issues.

⚙️ Write code to fix a Bug / new Feature Request

  We welcome contributions that help make this repo bug-free & improve the test automation experience for our users. You can also find issues tagged Good First Issues. Check out the below sections to begin.

Writing Code

All submissions, including submissions by project members, require review. Before raising a pull request, ensure you have raised a corresponding issue and discussed a possible solution with a maintainer. This gives your pull request the highest chance of getting merged quickly. Join our Discord Server if you need any help.

Set up your branch to write code

We use Github Flow, so all code changes happen through pull requests. Learn more.

  1. Please make sure there is an issue associated with the work that you're doing. If it doesn’t exist, create an issue.
  2. If you're working on an issue, please comment that you are doing so to prevent duplicate work by others also.
  3. Fork the repo and create a new branch from the dev branch.
  4. Please name the branch as issue-[issue-number]-[issue-name(optional)] or feature-[feature-number]–[feature-name(optional)]. For example, if you are fixing Issue #205 name your branch as issue-205 or issue-205-selectbox-handling-changes
  5. Squash your commits and refer to the issue using Fix #<issue-no> in the commit message, at the start.
  6. Rebase dev with your branch and push your changes.
  7. Raise a pull request against the master branch of the main repository.

Formatting code

We use spotless to manage proper and consistent formatting throughout the project.

  • ./gradlew spotlessCheck will check your code for formatting issues
  • ./gradlew spotlessApply will fix the formatting issues (if any)

Committing Code

The repository contains one important (protected) branch:

  • master contains the code that is tested, released, and currently under development.

All pull requests should be made directly against the master branch. Features and fixes that are ready for release will be merged into this branch after review and testing.

Commit & Create Pull Requests

  1. Please make sure there is an issue associated with the work that you're doing. If it doesn’t exist, create an issue.
  2. Squash your commits and refer to the issue using Fix #<issue-no> in the commit message, at the start.
  3. Rebase master with your branch and push your changes.
  4. Once you are confident in your code changes, create a pull request in your fork to the master branch in the LambdaTest/test-at-scale base repository.
  5. Link the issue of the base repository in your Pull request description. Guide on Linking a pull request to an issue

Commit messages

  • The first line should be a summary of the changes, not exceeding 50 characters, followed by an optional body that has more details about the changes. Refer to this link for more information on writing good commit messages.

  • Don't add a period/dot (.) at the end of the summary line.