Refactor Readme - Githubissues

Samagra-Development / WarpSQL

WarpSQL

https://samagra-development.github.io/WarpSQL/

Apache License 2.0

16 stars 28 forks source link

Refactor Readme #30

Closed AtulRajput01 closed 1 year ago

AtulRajput01 commented 1 year ago

Refactor Readme: Update WarpSQL value, add contribution section, and other improvements

This PR addresses issue and implements the requested changes for the WarpSQL project's README file. The changes include:

Rewrite the value of WarpSQL to better highlight its benefits and features.
Add a contribution section that includes instructions for both Gitpod and Codespaces.
Ensure CI passes before merging any contributions.
Provide information on how to publish the project.

Please review the changes and consider merging them into the main branch. Thank you!

singhalkarun commented 1 year ago

Hi @AtulRajput01, thanks for taking time to refactor the Readme. I see commits which are not associated with the Readme Refactoring. Can you please eliminate those commits from this PR and raise a separate PR for the same mentioning respective issue?

AtulRajput01 commented 1 year ago

Hi @singhalkarun , thank you for your feedback. I appreciate your guidance. I have reviewed the pull request and removed the unrelated commits from the PR. The changes now exclusively focus on the Readme refactoring. I apologize for the inconvenience caused by including the unrelated commits initially.

I have deleted the files and commits that were unrelated to the Readme refactoring. The pull request now accurately reflects the intended changes.

Please let me know if there is anything else I can do or if you have any further suggestions. I will be happy to address them. Thank you for your understanding.

singhalkarun commented 1 year ago

Hey @AtulRajput01 you have mistakenly also deleted the Dockerfile, can you please revert the Dockerfile to it's original state as on main branch.

AtulRajput01 commented 1 year ago

hello @singhalkarun sir, Apologies for the mistake in deleting the Dockerfile in the previous pull request. I appreciate your guidance in rectifying it. To ensure the integrity of the codebase and maintain consistency with the main branch, I have reverted the Dockerfile to its original state.

By creating a new pull request, we can present a clean and accurate set of changes for review. This will allow us to demonstrate the correct modifications made while ensuring the Dockerfile remains intact.