Added CONTRIBUTING.md and edited README.md file with instructions to install and run the project #13

IvaniGabrovsky · 2022-11-17T22:22:39Z

I added instructions in the README.md file to install dependancies and run the project. I added instructions how to contrbute to this project in the CONTRIBUTING.md file.

…install and run the project

SerpentBytes

Is it possible to use only markdown syntax in the .md file? Can we replace <br> with the markdown equivalent of br tag?

IvaniGabrovsky · 2022-11-17T22:44:53Z

Is it possible to use only markdown syntax in the .md file? Can we replace <br> with the markdown equivalent of br tag?

I am not sure what is the equilevant in .md to
?

SerpentBytes · 2022-11-17T22:54:17Z

@IvaniGabrovsky, actually it's fine. LGTM.

humphd · 2022-11-17T23:00:37Z

README.md

+
+## Usage
+
+To see the application running type F5. A new window will pop up with a hello message.


Type F5 in what? I think this is missing a bunch of info and needs more detail

I added more detail. Please take a look at it.

SerpentBytes

I am viewing the document on GitHub here

I think in some places, we don't really need <br> tags, as it's adding unnecessary padding. For instance, after the first heading, and before the first instance of the bolded heading.

SerpentBytes · 2022-11-17T23:26:45Z

Also, I don't think you need to make the heading bold, because it wouldn't do anything.

SerpentBytes · 2022-11-17T23:30:28Z

CONTRIBUTING.md

@@ -0,0 +1,86 @@
+# Guidelines for Contribution
+
+<br>


This is adding extra padding.

SerpentBytes · 2022-11-17T23:31:27Z

CONTRIBUTING.md

+
+<br>
+
+## **Here is a brief overview of how to contribute to vscode-seneca-college:**


You don't need to make Headings bold. They are by default bolded.

SerpentBytes · 2022-11-17T23:38:53Z

CONTRIBUTING.md

+
+14. After your pull request is merged, celebrate your achievement!
+
+## <br>


This would render in HTML: <h2 id=""><br></h2> I don't think you need to make it a heading.

SerpentBytes · 2022-11-17T23:39:43Z

CONTRIBUTING.md

+
+## <br>
+
+### THANK YOU FOR YOUR PARTICIPATION!


I think you shouldn't conclude a document with a heading.

humphd · 2022-11-17T23:45:03Z

README.md

+
+## Usage
+
+To see the application running type F5 with your keyboard in any file of the project. Just make sure your mouse is in any of files in the project. A new window will pop up with a hello message. You are now in debugging mode. You can debug the code to find out what it is doing with the step forward step inward step out of buttons. Or press the red square to exit debugging mode.


This still doesn't make sense to me.

Imagine I do exactly what you just said:

I run npm i to install the dependencies (I'm in a terminal)

Now I cd into the project folder. This seems odd, since the project folder should be where I do npm i

Now I press F5 in my terminal? That doesn't do anything

Checking out package.json scripts is probably a good place to start:

vscode-seneca-college/package.json

Lines 33 to 43 in 57ce8f8

"scripts": {

"build": "tsup src/index.ts --external vscode",

"dev": "nr build --watch",

"lint": "eslint .",

"vscode:prepublish": "nr build",

"publish": "vsce publish --no-dependencies",

"pack": "vsce package --no-dependencies",

"test": "vitest",

"typecheck": "tsc --noEmit",

"release": "bumpp && nr publish"

},

I fixed it. Let me know if it is better.

humphd

Also, agree with @SerpentBytes re: removing the <br> tags (not necessary) and also letting Markdown properly format the titles (e.g., you don't need to bold them).

gulyapulya

Some suggestions:

gulyapulya · 2022-11-18T04:08:49Z

CONTRIBUTING.md

+
+<br>
+
+## How can I contribute in vscode-seneca-college project?


I think grammatically, it would be better to say "contribute to" rather than "contribute in"

gulyapulya · 2022-11-18T04:10:16Z

CONTRIBUTING.md

+
+<br>
+
+Never contributed to open source before? Are you curious in how contributions function in our project?


Suggestion: "curious about"

gulyapulya · 2022-11-18T04:13:34Z

CONTRIBUTING.md

+
+<br>
+
+1. Start by identifying an issue or a feature that you would want to add.


Probably good to mention that contributors can file issues themselves if they have an idea that has not been documented yet or choose an existing issue from the "issues" tab.

gulyapulya · 2022-11-18T04:19:51Z

CONTRIBUTING.md

+
+<br>
+
+2. In your local GitHub organization, fork the repository linked to the problem. The repository `underyour-GitHub-username/repository-name` will now be accessible to you.


Most probably a personal user account will be used rather than an organization, so can be changed to "Fork current repository to produce a personal copy of this project by clicking the "Fork" button in the upper right corner of your screen. If you leave the default settings, the repository "your-username/vscode-seneca-college" will now be appear under your profile."

gulyapulya · 2022-11-18T04:23:58Z

README.md

+
+## Usage
+
+To see the application running type F5 with your keyboard in any file of the project. Just make sure your mouse is in any of files in the project. A new window will pop up with a hello message. You are now in debugging mode. You can debug the code to find out what it is doing with the step forward step inward step out of buttons. Or press the red square to exit debugging mode.


Checking out package.json scripts is probably a good place to start:

vscode-seneca-college/package.json

Lines 33 to 43 in 57ce8f8

"scripts": {

"build": "tsup src/index.ts --external vscode",

"dev": "nr build --watch",

"lint": "eslint .",

"vscode:prepublish": "nr build",

"publish": "vsce publish --no-dependencies",

"pack": "vsce package --no-dependencies",

"test": "vitest",

"typecheck": "tsc --noEmit",

"release": "bumpp && nr publish"

},

IvaniGabrovsky · 2022-11-18T05:50:06Z

I just did all the feedback that gulyapulya suggested me to do. Please let me know if it is better.

gulyapulya · 2022-11-18T06:12:47Z

Good job @IvaniGabrovsky! CONTRIBUTING.md seems good (@SerpentBytes suggestions were also nice to have but not necessary). I think it can be merged but the README.md needs more work.

IvaniGabrovsky · 2022-11-18T15:48:24Z

Good job @IvaniGabrovsky! CONTRIBUTING.md seems good (@SerpentBytes suggestions were also nice to have but not necessary). I think it can be merged but the README.md needs more work.

I don't see what else needs more work in README.md. Could you be more descriptive to what you think needs to be added in README.md

rudychung

Since there are so many steps to contribution, you may want to separate them under different headings. Maybe something like "Installing Locally", "Submitting Your Changes", etc., or you could condense some of your steps together?

rudychung · 2022-11-18T18:21:36Z

CONTRIBUTING.md

+
+## **Here is a brief overview of how to contribute to vscode-seneca-college:**
+
+---


I don't think that this horizontal rule is necessary, since the header above already separates the content above from the content below.

rudychung · 2022-11-18T18:31:06Z

CONTRIBUTING.md

+
+<br>
+
+2. In your local GitHub organization, Fork current repository to produce a personal copy of this project by clicking the "Fork" button in the upper right corner of your screen. If you leave the default settings, the repository `underyour-GitHub-username/repository-name` will now be appear under your profile.


Minor grammatical issue.
"will now be appear under your profile." should be "will now appear under your profile.". Although, a better change might be "should appear under your profile.", since the default settings might not always have the repo appear under your profile (e.g., if you've forked the repo already, it might default to forking it under an organization you're a part of).

I fixed the gramatic error.

IvaniGabrovsky · 2022-11-18T19:09:07Z

I applied all of your changes. Let me know if it is better now.

SerpentBytes

The changes I requested looks good to me. Good job.

gulyapulya · 2022-11-18T21:59:55Z

Good job @IvaniGabrovsky! CONTRIBUTING.md seems good (@SerpentBytes suggestions were also nice to have but not necessary). I think it can be merged but the README.md needs more work.

I don't see what else needs more work in README.md. Could you be more descriptive to what you think needs to be added in README.md

I think the professor's comments about the installation steps in README.md are valid, they are mostly missing, but we can leave it for now as is and add details later. One step to add from the top of my mind is that after the installation to run the extension in development mode, the developer can go to the run and debug tab on the left in VSCode ( shft+cmd+D) and click run extension. It will open a new window with the vscode in dev mode.

anshul137 · 2022-11-19T03:37:31Z

README.md

+
+## Usage
+
+Make sure your mouse is in any project files, not in the terminal but on any line of code. Then to see the application running. Type F5 with your keyboard. A new window will pop up with a hello message. You are now in debugging mode. You can debug the code to find out what it is doing with the step forward, step inward, and step out of buttons. Or press the red square to exit debugging mode.


I believe this line is confusing Make sure your mouse is in any project files, not in the terminal but on any line of code.

You can simply say Make sure your Text cursor is in Editor

I edited it.

sfrunza13 · 2022-11-23T21:27:46Z

CONTRIBUTING.md

+
+---
+
+1. Start by identifying an issue or a feature that you would want to add. Choose a issue from the issues tab that you would like to work on. Feel free to open a new issue in the project if it is not in the list of issues.


If I am being REALLY nit picky, the second sentence should also be an issue instead of a issue.

Myrfion · 2022-11-25T01:21:55Z

CONTRIBUTING.md

+git clone https://github.com/github-username/vscode-seneca-college.
+```
+
+4. Create working branch:


Don't wanna be super picky, but you should probably add a between the working branch so -> 4. Create a working branch:

added CONTRIBUTING.md and edited README.md file with instructions to …

1017dee

…install and run the project

SerpentBytes suggested changes Nov 17, 2022

View reviewed changes

humphd requested changes Nov 17, 2022

View reviewed changes

edited README.md to be more specific when running the project

4fb9e5d

SerpentBytes reviewed Nov 17, 2022

View reviewed changes

CONTRIBUTING.md Outdated

@@ -0,0 +1,86 @@

# Guidelines for Contribution

<br>

Copy link

SerpentBytes Nov 17, 2022

Choose a reason for hiding this comment

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

This is adding extra padding.

SerpentBytes suggested changes Nov 17, 2022

View reviewed changes

humphd requested changes Nov 17, 2022

View reviewed changes

gulyapulya suggested changes Nov 18, 2022

View reviewed changes

fixed some grammatic errors

61ca64b

rudychung suggested changes Nov 18, 2022

View reviewed changes

IvaniGabrovsky added 4 commits November 18, 2022 13:45

fixed formatting and removed brs

32fd053

changed end heading to regular text

63507ca

edited the grammer of the README.md file

6fcd1ef

fixed grammatic error in CONTRIBUTING.md file

1884d4a

SerpentBytes approved these changes Nov 18, 2022

View reviewed changes

anshul137 suggested changes Nov 19, 2022

View reviewed changes

edited grammer in README.md file

50f534c

sfrunza13 reviewed Nov 23, 2022

View reviewed changes

Myrfion reviewed Nov 25, 2022

View reviewed changes


		## Usage

		To see the application running type F5. A new window will pop up with a hello message.


		<br>

		## Here is a brief overview of how to contribute to vscode-seneca-college:


		14. After your pull request is merged, celebrate your achievement!

		## <br>


		## Usage

		To see the application running type F5 with your keyboard in any file of the project. Just make sure your mouse is in any of files in the project. A new window will pop up with a hello message. You are now in debugging mode. You can debug the code to find out what it is doing with the step forward step inward step out of buttons. Or press the red square to exit debugging mode.

	"scripts": {
	"build": "tsup src/index.ts --external vscode",
	"dev": "nr build --watch",
	"lint": "eslint .",
	"vscode:prepublish": "nr build",
	"publish": "vsce publish --no-dependencies",
	"pack": "vsce package --no-dependencies",
	"test": "vitest",
	"typecheck": "tsc --noEmit",
	"release": "bumpp && nr publish"
	},


		<br>

		## How can I contribute in vscode-seneca-college project?


		<br>

		Never contributed to open source before? Are you curious in how contributions function in our project?


		<br>

		1. Start by identifying an issue or a feature that you would want to add.


		<br>

		2. In your local GitHub organization, fork the repository linked to the problem. The repository `underyour-GitHub-username/repository-name` will now be accessible to you.


		## Usage

		Make sure your mouse is in any project files, not in the terminal but on any line of code. Then to see the application running. Type F5 with your keyboard. A new window will pop up with a hello message. You are now in debugging mode. You can debug the code to find out what it is doing with the step forward, step inward, and step out of buttons. Or press the red square to exit debugging mode.

Added CONTRIBUTING.md and edited README.md file with instructions to install and run the project #13

Are you sure you want to change the base?

Added CONTRIBUTING.md and edited README.md file with instructions to install and run the project #13

Conversation

IvaniGabrovsky commented Nov 17, 2022

SerpentBytes left a comment • edited Loading

Choose a reason for hiding this comment

IvaniGabrovsky commented Nov 17, 2022

SerpentBytes commented Nov 17, 2022

Choose a reason for hiding this comment

Choose a reason for hiding this comment

SerpentBytes left a comment • edited Loading

Choose a reason for hiding this comment

SerpentBytes commented Nov 17, 2022

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

humphd left a comment

Choose a reason for hiding this comment

gulyapulya left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

IvaniGabrovsky commented Nov 18, 2022

gulyapulya commented Nov 18, 2022

IvaniGabrovsky commented Nov 18, 2022

rudychung left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

IvaniGabrovsky commented Nov 18, 2022

SerpentBytes left a comment

Choose a reason for hiding this comment

gulyapulya commented Nov 18, 2022

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Myrfion Nov 25, 2022 • edited Loading

Choose a reason for hiding this comment

SerpentBytes left a comment •

edited

Loading

SerpentBytes left a comment •

edited

Loading

Myrfion Nov 25, 2022 •

edited

Loading