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.

Sign up for GitHub

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

Jump to bottom

Simplify language and structure for clarity and ease of use. #35943

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Simplify language and structure for clarity and ease of use. #35943

wants to merge 1 commit into from
+34 −34

Conversation

sanskaarz
Copy link

Summary of the Pull Request

Streamlined language, clarified sections, and enhanced instructions for a more concise, user-friendly contributor guide.

PR Checklist

  • Closes: #xxx
  • Communication: I've discussed this with core contributors already. If work hasn't been agreed, this work might be rejected
  • Tests: Added/updated and all pass
  • Localization: All end user facing strings can be localized
  • Dev docs: Added/updated
  • New binaries: Added on the required places
  • Documentation updated: If checked, please file a pull request on our docs repo and link it here: #xxx

Detailed Description of the Pull Request / Additional comments

  1. Headings for Clarity:

    • Created a clearer heading for the “Filing an Issue” section to emphasize its importance.
    • Changed "How to Tell the PowerToys Team This is an Interesting Thing to Focus On" to “Indicating Interest in Issues” for conciseness.

  2. Revised Filing Instructions:

    • Broke down filing instructions into concise, actionable points.
    • Clarified when and why users should file issues and conduct a quick search before filing.

  3. Simplified "Contributing Fixes/Features" Section:

    • Added clear instructions to comment on interest before starting work.
    • Reworded to avoid redundancy, especially around the team’s guidance and multiple contributors.

  4. Streamlined Localization and Help Wanted Sections:

    • Rephrased the localization section to be direct, avoiding unnecessary detail.
    • Revised “Help Wanted” to direct users simply to the labeled issues for easy navigation.

  5. Refined "Thank You" Note:

    • Added a closing thank-you note that highlights collaboration and the value of community contributions.

These changes make the guide easier to follow, more structured, and clearer for contributors.

Validation Steps Performed

All tests passed, confirming feature reliability.

@sanskaarz
Simplify language and structure for clarity and ease of use.
f683599 
1. Clearer Section Headings: Renamed sections like "Indicating Interest in Issues" to improve readability.
2. Conciseness and Flow: Shortened sentences and rephrased for directness.
3. Improved Organization: Streamlined instructions in sections like “Filing an Issue” and “Contributing Fixes/Features.”
4. Reduced Redundancy: Simplified repetitive language, especially in localization and contribution details.
5. Enhanced Call to Action: Adjusted "Help Wanted" and "Becoming a Collaborator" to guide users clearly on next steps.
@sanskaarz
Copy link
Author

@microsoft-github-policy-service agree

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers
No reviews
Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
1 participant
@sanskaarz