From c14379bb1333a624ed22f2178acbc014b7865d79 Mon Sep 17 00:00:00 2001 From: Halim Date: Fri, 5 Apr 2024 15:02:53 +0430 Subject: [PATCH] contributing section added to the README.md --- README.md | 37 ++++++++++++++++++++++++++++++------- 1 file changed, 30 insertions(+), 7 deletions(-) diff --git a/README.md b/README.md index 9c00745..fbea97b 100644 --- a/README.md +++ b/README.md @@ -11,7 +11,7 @@ #### [Homepage](https://nightwatchjs.org) • [Developer Guide](https://nightwatchjs.org/guide) • [API Reference](https://nightwatchjs.org/api) • [About](https://nightwatchjs.org/about) • [Blog](https://nightwatchjs.org/blog) -Nightwatch is an integrated testing framework powered by Node.js and using the [W3C Webdriver API](https://www.w3.org/TR/webdriver/). It is a complete testing solution developed at [BrowserStack](https://www.browserstack.com/) and which can be used for: +Nightwatch is an integrated testing framework powered by Node.js and using the [W3C Webdriver API](https://www.w3.org/TR/webdriver/). It is a complete testing solution developed at [BrowserStack](https://www.browserstack.com/) and which can be used for: ☑️ end-to-end testing of web applications and websites @@ -33,7 +33,6 @@ npm init nightwatch@latest or, if you want to initialize a new project: - ```sh npm init nightwatch@latest ./path/to/new/project ``` @@ -52,11 +51,11 @@ npm init nightwatch@latest -- --generate-config #### 2. Answer a few questions about your preferred setup: -- What is your Language - Test Runner setup? -- Where do you want to run your e2e tests? -- Which browsers will you be testing on? -- Where do you plan to keep your end-to-end tests? -- What is the base_url of your project? +- What is your Language - Test Runner setup? +- Where do you want to run your e2e tests? +- Which browsers will you be testing on? +- Where do you plan to keep your end-to-end tests? +- What is the base_url of your project? - Allow Nightwatch to anonymously collect usage metrics? - Would you like to run your e2e tests on Mobile devices as well? @@ -70,8 +69,32 @@ You can follow the instructions given at the end of the setup to run your first image +## Contributing + +We welcome any and all community contributions that may help us enhance Nightwatch. + +### Running locally + +1. First, fork the repository to your own GitHub account. +2. Clone the forked repository from your own GitHub account by running the following command in terminal: + ```sh + git clone https://github.com//create-nightwatch.git + ``` +3. Navigate to the locally cloned repository: + ```sh + cd create-nightwatch + ``` +4. Install all the dependencies: + ```sh + npm install + ``` +5. Run the project locally: + ```sh + npm run create-nightwatch + ``` ## Licence + [MIT](https://github.com/nightwatchjs/nightwatch/blob/main/LICENSE.md) [discord-badge]: https://img.shields.io/discord/618399631038218240.svg?color=7389D8&labelColor=6A7EC2&logo=discord&logoColor=ffffff&style=flat-square