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

Improve Clarity of Command Presentation in Contributing.md #973

Closed
3 tasks done
Vaishnavigupta1312 opened this issue May 15, 2024 · 1 comment
Closed
3 tasks done

Comments

@Vaishnavigupta1312
Copy link

Vaishnavigupta1312 commented May 15, 2024

What's wrong with the existing documentation

In the contributing.md file, there's a section where the command for creating and checking out to a new branch is provided. However, the presence of "PowerShell" preceding the command might confuse contributors, leading them to question whether it's part of the command or indicating the terminal prompt.

To enhance clarity and prevent confusion, we should revise the presentation of the command to make it clear that "PowerShell" is not part of the command itself but rather indicates the terminal or shell environment. This adjustment will ensure that contributors understand the command structure correctly and can follow the instructions accurately.

Proposed Changes:

Remove "PowerShell" from the command presentation to avoid confusion.
Clearly indicate that the provided command is to be executed in the terminal or shell environment.
By making these adjustments, I aim to improve the clarity of instructions in the contributing.md file, thereby enhancing the overall contributor experience and facilitating smoother collaboration within the project.

Add ScreenShots

Scrape-up-Powershell

Record

  • I agree to follow this project's Code of Conduct
  • I'm a GSSoC'24 contributor
  • I want to work on this issue
@Vaishnavigupta1312
Copy link
Author

Vaishnavigupta1312 commented May 15, 2024

@nikhil25803 Please assign this issue to me and also add labels to this issue - 'GSSOC'24' and 'Level'

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

No branches or pull requests

2 participants