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

Improved README : Added Table of Contents, Project Overview, Contribution Guidelines, and Social Media Links #4564

Open
wants to merge 2 commits into
base: main
Choose a base branch
from

Conversation

Ayah-Saleh
Copy link

This pull request modified the SumoLogic README to make it more informative and user-friendly for new and existing contributors. This included:

  • Added a Table of Contents to improve navigation.
  • Added the Project Overview and Key Features sections to give the target audience/potential contributors a clearer understanding of SumoLogic's functions.
  • Expanded on the Contribution Guidelines, I included a how to contribute which detailed forking, branching, and submitting pull requests.
  • Added a Get Involved Section in order to encourage the audience to keep with SumoLogic and its updates on social media.

These changes were made in order to make the README more informative/clear for potential contributors.

…ct, brief description of key features, contribution guidelines, how to contribute, and social media links.
Copy link

cla-bot bot commented Sep 20, 2024

Thank you for your contribution! As this is an open source project, we require contributors to sign our Contributor License Agreement and do not have yours on file. To proceed with your PR, please sign your name here and we'll add you to our approved list of contributors.

@jpipkin1 jpipkin1 mentioned this pull request Sep 20, 2024
4 tasks
@jpipkin1 jpipkin1 added the doc:update Revisions and updates to content label Sep 20, 2024
@cla-bot cla-bot bot added the cla-signed Contributor approved, listed in .clabot file label Sep 20, 2024
@kimsauce
Copy link
Collaborator

@Ayah-Saleh many thanks for submitting these improvements! Nice work. I'll take this back to our team to go over in our next meeting. FYI: @jpipkin1 @mafsumo @JV0812

@kimsauce kimsauce added the do-not-merge Pull requests that should not be merged label Sep 23, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
cla-signed Contributor approved, listed in .clabot file do-not-merge Pull requests that should not be merged doc:update Revisions and updates to content
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants