|
| 1 | +# Contributing |
| 2 | + |
| 3 | +Thank you for your interest and for taking the time to contribute to this project. |
| 4 | +If you feel insecure about how to start contributing, |
| 5 | +feel free to ask us on our [Discord Server](https://discord.gg/99wgdtQ99h) in the #open-source channel. |
| 6 | + |
| 7 | +## **Code of conduct** |
| 8 | + |
| 9 | +Read our [Code of Conduct](CODE_OF_CONDUCT.md) before contributing. |
| 10 | + |
| 11 | +## **How can I contribute?** |
| 12 | + |
| 13 | +There are many ways in which you can contribute to this repository. |
| 14 | + |
| 15 | +#### 👥 Join the community |
| 16 | +  Join our [Discord server](https://discord.gg/99wgdtQ99h). |
| 17 | + |
| 18 | +#### 🐞 Report a bug |
| 19 | +  Report all issues through [GitHub Issues](https://github.com/LambdaTest/wdio-lambdatest-service/issues) and |
| 20 | +provide as much information as you can. |
| 21 | + |
| 22 | +#### 🛠 Create a feature request |
| 23 | +  We welcome all feature requests, whether for new features |
| 24 | +or enhancements to existing features. File your feature request through [GitHub Issues](https://github.com/LambdaTest/wdio-lambdatest-service/issues/new/choose). |
| 25 | + |
| 26 | +#### ⚙️ Write code to fix a Bug / new Feature Request |
| 27 | +  We welcome contributions that help make this |
| 28 | +repo bug-free & improve the test automation experience for our users. |
| 29 | +You can also find issues |
| 30 | +tagged [Good First Issues](https://github.com/LambdaTest/wdio-lambdatest-service/issues). |
| 31 | +Check out the below sections to begin. |
| 32 | + |
| 33 | +## **Writing Code** |
| 34 | + |
| 35 | +All submissions, including submissions by project members, |
| 36 | +require review. Before raising a pull request, ensure you have |
| 37 | +raised a corresponding issue and discussed a possible solution with a maintainer. |
| 38 | +This gives your pull request the highest chance of getting merged quickly. |
| 39 | +Join our [Discord Server](https://discord.gg/99wgdtQ99h) if you need any help. |
| 40 | + |
| 41 | +### Set up your branch to write code |
| 42 | + |
| 43 | +We use [Github Flow](https://docs.github.com/en/get-started/using-github/github-flow), |
| 44 | +so all code changes happen through pull requests. |
| 45 | +[Learn more.](https://blog.scottlowe.org/2015/01/27/using-fork-branch-git-workflow/) |
| 46 | + |
| 47 | +1. Please make sure there is an issue associated with the work that you're doing. If it doesn’t exist, [create an issue.](https://github.com/LambdaTest/wdio-lambdatest-service/issues) |
| 48 | +2. If you're working on an issue, please comment that you are doing so to prevent duplicate work by others also. |
| 49 | +3. Fork the repo and create a new branch from the `dev` branch. |
| 50 | +4. Please name the branch as <span style="color:grey">issue-[issue-number]-[issue-name(optional)]</span> or <span style="color:grey">feature-[feature-number]–[feature-name(optional)]</span>. For example, if you are fixing Issue #205 name your branch as <span style="color:grey">issue-205 or issue-205-selectbox-handling-changes</span> |
| 51 | +5. Squash your commits and refer to the issue using `Fix #<issue-no>` in the commit message, at the start. |
| 52 | +6. Rebase `dev` with your branch and push your changes. |
| 53 | +7. Raise a pull request against the master branch of the main repository. |
| 54 | + |
| 55 | +## **Committing Code** |
| 56 | + |
| 57 | +The repository contains one important (protected) branch: |
| 58 | + |
| 59 | +- **master** contains the code that is tested, released, and currently under development. |
| 60 | + |
| 61 | +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. |
| 62 | + |
| 63 | +#### **Commit & Create Pull Requests** |
| 64 | + |
| 65 | +1. Please make sure there is an issue associated with the work that you're doing. If it doesn’t exist, [create an issue](https://github.com/LambdaTest/wdio-lambdatest-service/issues). |
| 66 | +2. Squash your commits and refer to the issue using `Fix #<issue-no>` in the commit message, at the start. |
| 67 | +3. Rebase `master` with your branch and push your changes. |
| 68 | +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. |
| 69 | +5. Link the issue of the base repository in your Pull request description. [Guide on Linking a pull request to an issue](https://docs.github.com/en/issues/tracking-your-work-with-issues/linking-a-pull-request-to-an-issue) |
| 70 | + |
| 71 | +#### **Commit messages** |
| 72 | + |
| 73 | +- The first line should be a summary of the changes, not exceeding 50 |
| 74 | + characters, followed by an optional body that has more details about the |
| 75 | + changes. Refer to [this link](https://github.com/erlang/otp/wiki/writing-good-commit-messages) |
| 76 | + for more information on writing good commit messages. |
| 77 | + |
| 78 | +- Don't add a period/dot (.) at the end of the summary line. |
0 commit comments