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.

Sign up for GitHub

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

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

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

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

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
8 commits
Select commit Hold shift + click to select a range
1017dee
added CONTRIBUTING.md and edited README.md file with instructions to …
IvaniGabrovsky Nov 17, 2022
4fb9e5d
edited README.md to be more specific when running the project
IvaniGabrovsky Nov 17, 2022
61ca64b
fixed some grammatic errors
IvaniGabrovsky Nov 18, 2022
32fd053
fixed formatting and removed brs
IvaniGabrovsky Nov 18, 2022
63507ca
changed end heading to regular text
IvaniGabrovsky Nov 18, 2022
6fcd1ef
edited the grammer of the README.md file
IvaniGabrovsky Nov 18, 2022
1884d4a
fixed grammatic error in CONTRIBUTING.md file
IvaniGabrovsky Nov 18, 2022
50f534c
edited grammer in README.md file
IvaniGabrovsky Nov 22, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
86 changes: 86 additions & 0 deletions CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,86 @@
# Guidelines for Contribution

<br>
Copy link

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.


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

Choose a reason for hiding this comment

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

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


<br>

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

Choose a reason for hiding this comment

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

Suggestion: "curious about"

Here is a brief summary!

<br>

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

Choose a reason for hiding this comment

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

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


---
Copy link

Choose a reason for hiding this comment

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

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


<br>

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

Choose a reason for hiding this comment

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

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.


<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.
Copy link

Choose a reason for hiding this comment

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

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."


<br>

3. Make a local copy of the repository using:

```
git clone https://github.com/github-username/vscode-seneca-college.
```

4. Create working branch:
Copy link
Contributor

@Myrfion Myrfion Nov 25, 2022 •
edited
Loading

Choose a reason for hiding this comment

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

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


```
git checkout -b branch-name
```

5. Include the upstream remote:

```
git push --set-upstream origin branch-name
```

6. If you think your fork is behind, pull the most recent changes from the main repository:

```
git pull upstream main
```

7. Make the necessary adjustments for the problem you're attempting to solve or the feature you want to include.

<br>

8. Merge the modifications into the branch you're working on by adding them to staging.

<br>

9. Make the changes and push them to the remote repository by:

```
git push origin branch-name-here
```

10. Send an upstream repository a **pull request**.

<br>

11. Include a brief description of the modifications made in the pull request's title.

<br>

12. Watch for a maintainer to review the pull request.

<br>

13. Modify the pull request if the maintaining reviewer suggests it.

<br>

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

## <br>
Copy link

Choose a reason for hiding this comment

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

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


### THANK YOU FOR YOUR PARTICIPATION!
Copy link

Choose a reason for hiding this comment

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

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

14 changes: 14 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,3 +5,17 @@
## Overview

A VSCode Extension for Seneca College devs.

## Installation

1. Install the dependencies:

```
npm i
```

2. cd to project folder

## Usage

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

Choose a reason for hiding this comment

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

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

Copy link
Author

Choose a reason for hiding this comment

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

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