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

(Minor fixes and improvements) Update README.md #4160

Merged
merged 4 commits into from
Nov 18, 2023

Conversation

unpervertedkid
Copy link
Contributor

@unpervertedkid unpervertedkid commented Nov 18, 2023

Description

This PR includes both fixes and improvements to the README.md file.

Fixes

  • Broken LICENSE.md Link: A typo in the LICENSE.md link caused it to lead to a 404 error. This has been corrected, and the link now correctly points to the LICENSE.md file.
  • Broken Email Link: The email link was not functioning properly. This has been fixed, and the link now correctly opens a new email draft.

Improvements

  • Contributing Section: Direct links have been added to the GitHub issues labeled "Good first issue" and the process to create a fork of Quickwit. These additions will help new contributors get started more easily.
  • Community Section: The community section has been enhanced with more direct links to relevant resources, making it easier for users to engage with our community.

How was this PR tested?

This PR was tested by clicking on each of the newly added and corrected links in the README.md file. All links correctly redirect to their respective resources, confirming that they have been successfully added and are functioning as expected.

@unpervertedkid
Copy link
Contributor Author

@guilload Please mind taking a look at this?

@unpervertedkid unpervertedkid changed the title fix: Fix typo license link in README.md Fix typo license link in README.md Nov 18, 2023
@unpervertedkid unpervertedkid changed the title Fix typo license link in README.md Fix typo license link in README.md and add links to contributing section Nov 18, 2023
@unpervertedkid unpervertedkid changed the title Fix typo license link in README.md and add links to contributing section (Minor fixes and improvements) Update LICENSE.md Nov 18, 2023
@fulmicoton fulmicoton merged commit 7bad6bb into quickwit-oss:main Nov 18, 2023
4 checks passed
@unpervertedkid unpervertedkid changed the title (Minor fixes and improvements) Update LICENSE.md (Minor fixes and improvements) Update README.md Nov 18, 2023
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.

None yet

2 participants