Readme upadated #146
Closed
Readme upadated #146
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Please check the changes I made. This is my first time in open source contribution. Suggest anything if needed.
code-reaper08
requested changes
Apr 9, 2022
ReadME.md
Outdated
| @@ -143,7 +143,7 @@ This project is part of the [GirlScript Summer of Code 2022](https://gssoc.girls | |||
| | **[Praveen Kumar Purushothaman](https://praveen.science/)** | | |||
|
|
|||
| >**Need help?** | |||
| Feel free to contact me at [catsintech@praveen.science](mailto:catsintech@praveen.science). | |||
| Feel free to contact me at [catsintech@praveen.science](mail to:catsintech@praveen.science). | |||
There was a problem hiding this comment.
Hello @chetnaakhandagale 👋
This should be retained as original to work as expected!
I have made the suggested changes.
praveenscience
requested changes
Apr 10, 2022
There was a problem hiding this comment.
I am not sure this one's a valid one... But happy to provide some value. Kindly refrain from these kind of PRs before asking.
Like this is unacceptable, know what you're doing (as you're ruining things):
And this, seriously?
And this is definitely not right.
So, kindly understand how things works, take time to read what it has been written. It's already two months into the GSSoC 22 and still people make such issues! 😥
| @@ -2,7 +2,7 @@ | |||
|
|
|||
| [](https://github.com/CatsInTech/Rezume/issues) [](https://github.com/CatsInTech/Rezume/stargazers) [](https://github.com/CatsInTech/Rezume/network) [](https://github.com/CatsInTech/Rezume) | |||
|
|
|||
| Rezume is a free online portal for generating resumes without worrying about the styling and formatting. In the web portal, you only need to input the basic information which you want to have on your resume and it will automatically generate a decent resume for you. | |||
| Rezume is a free online portal for generating resumes without worrying about styling and formatting. In the web portal, you only need to input the basic information which you want to have on your resume and it will automatically generate a decent resume for you. | |||
| @@ -36,9 +36,9 @@ Rezume is a free online portal for generating resumes without worrying about the | |||
| As this is a React JS application, you need the following to support your development environment. | |||
| - [ ] [Git](https://git-scm.com/downloads) | |||
| - [ ] [Node.js](https://nodejs.org/en/) (Please go with any latest LTS versions) | |||
| - [ ] [Linux Based Terminal](https://gitforwindows.org/), if you're using Windows and installed with Git. | |||
| - [ ] [Linux Based Terminal](https://gitforwindows.org/) if you're using Windows and installed with Git. | |||
There was a problem hiding this comment.
Need a comma - basic grammar.
| - [ ] [Google Chrome](https://www.google.com/chrome/) or a decent latest web browser. | ||
| - [ ] **[Visual Studio Code](https://code.visualstudio.com/)** is the go-to editor for some complex languages like React using JSX or TypeScript and I finally agreed with [Wes Bos](https://wesbos.com/) that VS Code is better for development of React JS. Obviously, with VS Code, you should be having the right extensions to support your React JS development, but comparing with Sublime Text 2, VS Code is still in its infancy. Get these extensions and here's my [dotfile](https://gist.github.com/praveenscience/ebb5439f31774ad2fdc14cb9e7de1fc0): | ||
| - [ ] **[Visual Studio Code](https://code.visualstudio.com/)** is the go-to editor for some complex languages like React using JSX or TypeScript and I finally agreed with [Wes Bos](https://wesbos.com/) that VS Code is better for development of React JS. Obviously, with VS Code, you should be having the right extensions to support your React JS development, but compared with Sublime Text 2, VS Code is still in its infancy. Get these extensions and here's my [dotfile](https://gist.github.com/praveenscience/ebb5439f31774ad2fdc14cb9e7de1fc0): |
| @@ -50,7 +50,7 @@ As this is a React JS application, you need the following to support your develo | |||
|
|
|||
| ### Installation Instructions | |||
|
|
|||
| [Create React App](https://github.com/facebookincubator/create-react-app) is a comfortable environment for **learning React**, and is the best way to start building **a new [single-page](https://reactjs.org/docs/glossary.html#single-page-application) application** in React. This project makes use of Create React App. It sets up your development environment so that you can use the latest JavaScript features, provides a nice developer experience, and optimises your app for production. You’ll need to have [Node >= 8.10 and npm >= 5.6](https://nodejs.org/en/) on your machine. | |||
| [Create React App](https://github.com/facebookincubator/create-react-app) is a comfortable environment for **learning React**, and is the best way to start building **a new [single-page](https://reactjs.org/docs/glossary.html#single-page-application) application** in React. This project makes use of Create React App. It sets up your development environment so that you can use the latest JavaScript features, provides a nice developer experience, and optimizes your app for production. You’ll need to have [Node >= 8.10 and npm >= 5.6](https://nodejs.org/en/) on your machine. | |||
There was a problem hiding this comment.
We're not in Amreekah. We're either in India or the United Kingdom.
| @@ -80,7 +80,7 @@ As this is a React JS application, you need the following to support your develo | |||
| ```bash | |||
| npm start | |||
| ``` | |||
| 3. Open http://localhost:3000/ on your favourite browser. Let anyone from the mentoring team know, if you are facing any troubles. | |||
| 3. Open http://localhost:3000/ on your favourite browser. Let anyone from the mentoring team know if you are facing any troubles. | |||
There was a problem hiding this comment.
I'd go 75% with the comma here.
| @@ -110,15 +110,15 @@ This project is part of the [GirlScript Summer of Code 2022](https://gssoc.girls | |||
|
|
|||
| ### Frequently Asked Questions(FAQs) for [GSSoC '22](https://gssoc.girlscript.tech/) | |||
|
|
|||
| > This project is accepting contributions under [GirlScript Summer of Code 2022](https://gssoc.girlscript.tech/) - three months long Open Source program conducted by [GirlScript Foundation](https://gssoc.girlscript.tech/). | |||
| > This project is accepting contributions under [GirlScript Summer of Code 2022](https://gssoc.girlscript.tech/) - three-month long Open Source program conducted by [GirlScript Foundation](https://gssoc.girlscript.tech/). | |||
There was a problem hiding this comment.
Okay, this makes sense. 😊
Comment on lines
+117
to
+121
| **1. How to start as a beginner to contribute to the project?** | ||
| *There are many beginner-level issues to begin with, which include documentation, development, and design. Also, feel free to make issues for features as well as for reporting bugs. Participants can claim an issue by commenting that they are interested in it. We are also open to new ideas and suggestions.* | ||
|
|
||
| **2. How to communicate with us?** | ||
| *All communication will happen on the Slack channel for this particular projects. Mentors can also be reached through GitHub. Avoid DMs and unnecessary mentions on slack and GitHub both. *Checkout [this](https://github.com/CatsInTech/Rezume/issues) issue for more.** | ||
| *All communication will happen on the Slack channel for this particular project. Mentors can also be reached through GitHub. Avoid DMs and unnecessary mentions on slack and GitHub. *Check out [this](https://github.com/CatsInTech/Rezume/issues) issue for more.** |
There was a problem hiding this comment.
These are okay, maybe the last line could replace: [this](...) issue with [these issues](...).
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Please check the changes I made. This is my first time in open source contribution. Suggest anything if needed.
Issue that this pull request solves
Closes: #140
Proposed changes
I have made very few changes in the readme.
Types of changes
Put an
xin the boxes that applyChecklist
Put an
xin the boxes that applyScreenshots
Please attach the screenshots of the changes made in case of change in the user interface
Other information
Any other information that is important to this pull request