Skip to content

Enhance CONTRIBUTING.md with modern layout, badges, and contributor tips#163

Open
khujrat17 wants to merge 3 commits intodotnet-foundation:mainfrom
khujrat17:patch-2
Open

Enhance CONTRIBUTING.md with modern layout, badges, and contributor tips#163
khujrat17 wants to merge 3 commits intodotnet-foundation:mainfrom
khujrat17:patch-2

Conversation

@khujrat17
Copy link
Member

Enhance CONTRIBUTING.md with modern layout, badges, and contributor guidance

Description Of Change

Updated the CONTRIBUTING.md file to improve readability, accessibility, and contributor guidance.

Changes include:

  • Added .NET Foundation logo at the top and centered it.
  • Added badges: Code of Conduct, Contributions Welcome, License.
  • Added emojis/icons for key sections for visual guidance.
  • Modernized headings and spacing for a cleaner layout.
  • Added “Pro Tips” for submitting issues and pull requests.
  • Improved accessibility with alt text for images.
  • Reorganized content into clear sections: Code of Conduct, How to Contribute, Raising PRs, Licensing.

Purpose Of Change

  • To make the CONTRIBUTING.md more user-friendly, visually appealing, and aligned with modern GitHub repository standards.
    This ensures that new contributors can easily understand how to contribute and follow repository guidelines.

Related Issue

No specific issue, this is a documentation improvement.

Updated the contributing guidelines with new sections and improved formatting.
@glennawatson
Copy link

Let's avoid the emoji's please.

@khujrat17
Copy link
Member Author

ok sure..

Removed all emojis from headings and tips.

Retained badges, layout, and structure for readability and professionalism.

Preserved friendly tone and guidance for contributors.
Copy link
Member Author

@khujrat17 khujrat17 left a comment

Choose a reason for hiding this comment

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

Removed all emojis from headings and tips.

Retained badges, layout, and structure for readability and professionalism.

Preserved friendly tone and guidance for contributors.

Updated tips for issue submission process.
Copy link
Member Author

@khujrat17 khujrat17 left a comment

Choose a reason for hiding this comment

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

This PR updates CONTRIBUTING.md based on feedback to improve clarity for external contributors.

Changes include:

  • Removed tips about manually assigning committee members, as auto-assignment handles this.
  • Removed note about presenting ideas in meetings, which is only possible for members.
  • Updated suggestion section to clearly explain how external contributors can submit ideas.
  • Maintained professional layout, badges, and guidance for contributors.

Purpose:
To ensure that CONTRIBUTING.md is accurate, user-friendly, and aligns with repository policies for all contributors.

Related Issue:
No specific issue; documentation improvement based on committee feedback.

Checklist:

  • Updated suggestion instructions for external contributors
  • Removed member-only guidance
  • Verified formatting and badges
  • Documentation-only change; no code modifications

@khujrat17
Copy link
Member Author

thanks for your suggestion
all the suggestion noted and added in latest plz check it .

@khujrat17
Copy link
Member Author

Any status??

@glennawatson
Copy link

I'm happy with the changes but would like @cwoodruff opinion too.

@khujrat17
Copy link
Member Author

Thanks for review..

@khujrat17
Copy link
Member Author

Any update?

@codehippie1
Copy link
Member

I like the changes. Once @cwoodruff take a look at it, we can merge

@khujrat17
Copy link
Member Author

Hi 👋
Thanks for reviewing this! I see that PR #163 is still open. Could someone share the current review status and any remaining feedback needed?
Happy to update anything required — thanks in advance! 🙏

@codehippie1
Copy link
Member

@khujrat17 I added a couple of review comments. Please take a look. Once these are addressed, I should be able to merge.

@codehippie1
Copy link
Member

@khujrat17 Once you update the PR as per the comments, I can merge.

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.

3 participants