-
Notifications
You must be signed in to change notification settings - Fork 7
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
Added CONTRIBUTING.md and edited README.md file with instructions to install and run the project #13
base: main
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
Changes from 7 commits
1017dee
4fb9e5d
61ca64b
32fd053
63507ca
6fcd1ef
1884d4a
50f534c
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,60 @@ | ||
# Guidelines for Contribution | ||
|
||
## How can I contribute to vscode-seneca-college project? | ||
|
||
Never contributed to open source before? Are you curious about how contributions function in our project? | ||
Here is a brief summary! | ||
|
||
**Here is a brief overview of how to contribute to vscode-seneca-college:** | ||
|
||
--- | ||
|
||
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. | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. If I am being REALLY nit picky, the second sentence should also be an issue instead of a issue. |
||
|
||
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` should appear under your profile. | ||
|
||
3. Make a local copy of the repository using: | ||
|
||
``` | ||
git clone https://github.com/github-username/vscode-seneca-college. | ||
``` | ||
|
||
4. Create working branch: | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Don't wanna be super picky, but you should probably add |
||
|
||
``` | ||
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. | ||
|
||
8. Merge the modifications into the branch you're working on by adding them to staging. | ||
|
||
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**. | ||
|
||
11. Include a brief description of the modifications made in the pull request's title. | ||
|
||
12. Watch for a maintainer to review the pull request. | ||
|
||
13. Modify the pull request if the maintaining reviewer suggests it. | ||
|
||
14. After your pull request is merged, celebrate your achievement! | ||
|
||
THANK YOU FOR YOUR PARTICIPATION! |
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -5,3 +5,15 @@ | |
## Overview | ||
|
||
A VSCode Extension for Seneca College devs. | ||
|
||
## Installation | ||
|
||
Install the dependencies: | ||
|
||
``` | ||
npm i | ||
``` | ||
|
||
## 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. | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. I believe this line is confusing You can simply say Make sure your Text cursor is in Editor There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. I edited it. |
There was a problem hiding this comment.
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.