Add contributing md 120 #126
Merged
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
|
@chelseybeck @nyarly Please take a look at it, and make any suggestions for revision. Thank you |
chelseybeck
reviewed
Mar 28, 2024
CONTRIBUTING.md
Outdated
|
|
||
| ### **Working on an issue** | ||
|
|
||
| For each issue you address, create a new branch. Working on topic branches ensures that your main branch(named `master`)remains untouched and makes it easier to synchronize your fork with the main project. |
There was a problem hiding this comment.
Suggested change
| For each issue you address, create a new branch. Working on topic branches ensures that your main branch(named `master`)remains untouched and makes it easier to synchronize your fork with the main project. | |
| For each issue you address, create a new branch. Working on topic branches ensures that your main branch(named `main`)remains untouched and makes it easier to synchronize your fork with the main project. |
chelseybeck
reviewed
Mar 28, 2024
CONTRIBUTING.md
Outdated
|
|
||
| For each issue you address, create a new branch. Working on topic branches ensures that your main branch(named `master`)remains untouched and makes it easier to synchronize your fork with the main project. | ||
|
|
||
| #### **Working on an issue (1): Verify current branch is `master`** |
There was a problem hiding this comment.
Suggested change
| #### **Working on an issue (1): Verify current branch is `master`** | |
| #### **Working on an issue (1): Verify current branch is `main`** |
chelseybeck
reviewed
Mar 28, 2024
CONTRIBUTING.md
Outdated
|
|
||
| #### **Working on an issue (1): Verify current branch is `master`** | ||
|
|
||
| first make sure you are on the master branch. |
There was a problem hiding this comment.
Suggested change
| first make sure you are on the master branch. | |
| first make sure you are on the main branch. |
chelseybeck
reviewed
Mar 28, 2024
CONTRIBUTING.md
Outdated
| first make sure you are on the master branch. | ||
|
|
||
| ```bash | ||
| git checkout master |
There was a problem hiding this comment.
Suggested change
| git checkout master | |
| git checkout main |
chelseybeck
reviewed
Mar 28, 2024
CONTRIBUTING.md
Outdated
| git checkout master | ||
| ``` | ||
|
|
||
| Update your master branch with the latest changes |
There was a problem hiding this comment.
Suggested change
| Update your master branch with the latest changes | |
| Update your main branch with the latest changes |
chelseybeck
reviewed
Mar 28, 2024
CONTRIBUTING.md
Outdated
| Update your master branch with the latest changes | ||
|
|
||
| ``` | ||
| git pull upstream master |
There was a problem hiding this comment.
Suggested change
| git pull upstream master | |
| git pull upstream main |
chelseybeck
reviewed
Mar 28, 2024
CONTRIBUTING.md
Outdated
| After committing your changes locally, you can use below commands to push your committed changes to a remote repository, making them accessible to others working on the same projects. | ||
|
|
||
| ```bash | ||
| git push --set-upstream add-contributing-md-120 |
There was a problem hiding this comment.
Suggested change
| git push --set-upstream add-contributing-md-120 | |
| git push --set-upstream origin add-contributing-md-120 |
|
@awlFCCamp I recommended a few changes. GitHub used to default to naming branches 'master', but switched to 'main'. Newer repos (like ours) use 'main'. Other than that, this looks great! Thanks for working on it 😄 |
|
@chelseybeck I made changes. Please take a look at it, and make any suggestions for revision. Thank you. |
abbyz123
approved these changes
Apr 11, 2024
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.
Fixes #120
Added a contributing markdown file to provide clear instructions for new contributors. Added instructions for making contributions to the repo: forking repo, cloning repo, creating a new branch, adding committing, pushing changes, and creating a pull request.