Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Refactor commands in README. #4076

Merged
merged 3 commits into from
Mar 4, 2024
Merged

Refactor commands in README. #4076

merged 3 commits into from
Mar 4, 2024

Conversation

konavivekramakrishna
Copy link
Contributor

Thanks in advance for your contribution. Please follow the below steps in submitting a pull request, as it will help us with reviewing it quicker.

This pr removes the unnecessary dollar symbol while copying the command

  • Create a new branch from master (e.g. features/my-new-feature or issue/123-my-bugfix);
  • If you're fixing a bug also create an issue if one doesn't exist yet;
  • If it's a new feature explain why do you think it's necessary. Please check with the maintainers beforehand to make sure it is something that we will accept. Usually we only accept new features if we feel that they will benefit the entire community;
  • Please avoid sending PRs which contain drastic or low level changes. If you are certain that the changes are needed, please discuss them beforehand and indicate what the impact will be;
  • If your change is based on existing functionality please consider refactoring first. Pull requests that duplicate code will most likely be ignored;
  • Do not include changes that are not related to the issue at hand;
  • Follow the same coding style with regards to spaces, semicolons, variable naming etc.;
  • Always add unit tests - PRs without tests are most of the times ignored.

@CLAassistant
Copy link

CLAassistant commented Mar 1, 2024

CLA assistant check
All committers have signed the CLA.

@konavivekramakrishna
Copy link
Contributor Author

image

Copy link

@nothuman2718 nothuman2718 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The $ sign at the beginning of the line is a common convention used in documentation to represent the command prompt in a Unix-like operating system's shell (like Bash in Linux or macOS, or Git Bash in Windows).

@konavivekramakrishna
Copy link
Contributor Author

The $ sign at the beginning of the line is a common convention used in documentation to represent the command prompt in a Unix-like operating system's shell (like Bash in Linux or macOS, or Git Bash in Windows).

image

@garg3133 should i close this pr

Copy link

github-actions bot commented Mar 4, 2024

Status

  • ❌ No modified files found in the types directory.
    Please make sure to include types for any changes you have made. Thank you!.

@garg3133
Copy link
Member

garg3133 commented Mar 4, 2024

@konavivekramakrishna If the copy feature in README is copying the $ sign as well, then we should probably remove that.

Instead, can you add some comments in the first section (where three commands are present together) briefly explaining what each command does. For example:

# clone the project
git clone ...

# change directory
cd nightwatch

# install the dependencies
nom install

@konavivekramakrishna
Copy link
Contributor Author

image

@garg3133

Could you please check it out?

Is the above format okay, or would you like me to split it into separate sections?

@garg3133 garg3133 changed the title Update README.md Refactor commands in README. Mar 4, 2024
@garg3133
Copy link
Member

garg3133 commented Mar 4, 2024

@konavivekramakrishna Looks good!

README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
@garg3133 garg3133 merged commit 3502e34 into nightwatchjs:main Mar 4, 2024
17 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants