Creating a beginners guide to open source contribution #81
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
Adding steps.
Continuing the steps.
lazyplatypus
requested changes
Jan 8, 2021
|
|
||
|  | ||
|
|
||
| 2. You will then need to click on your profile link on the top right of the page and click my Repository once there you’ll see a copy version of bit project. |
There was a problem hiding this comment.
you need to italicize or add quotations to things you need to click, in this case my repository.
copy version of bit project? you mean the repo?
|
|
||
|  | ||
|
|
||
| 3. Once in your own Repository you can then edit, download, and upload anything you want for your own liking. |
There was a problem hiding this comment.
how do you edit download and upload anything. this is vague.
|
|
||
|  | ||
|
|
||
| 4. Once you feel that you have edited a file to your liking you would scroll down to "Commit Changes" And you would have two options, one "Commit directly to the **master** branch." Or "Create a new branch for this commit and start a pull request." Sounds difficult right? Well its not, What it means is you can either save all your edits into the fork or (copy) version of the repo you created. Or create a new branch and start a pull request which tell others about changes you've pushed to a branch in a repository on GitHub. But from our suggestions if you're working on multiple files it would be best to commit directly into your own fork before creating a pull request. |
There was a problem hiding this comment.
this is only for markdown files, not code. you need to make that clear. just to reiterate we need to encourage people to clone + make changes locally instead of on github.com
|
|
||
|  | ||
|
|
||
| 5. If you did click "Commit directly to the master branch." And you have feel like you finished editing everything in your repository it is now time to do a PR (Pull Request) Which is going to alert people about the changes you have commited and see if it would be ready to be pushed back onto the main repo. You're going to click Pull Request on the top left and then click New Pull Request. |
There was a problem hiding this comment.
What does it mean to commit directly to the master branch? what are branches?
|
|
||
|  | ||
|
|
||
| 6. Once you click New Pull Request you're going to see a [Title] Box and a [Description] Box. Within your Title you want to make sure its descriptive and for the Description you want to be sure to explain on what this Pull Request is about. |
There was a problem hiding this comment.
What is the purpose of this? what is this called?
|
|
||
|  | ||
|
|
||
| 7. After you completed both the box you're going to include an issue if the pullrequest does have an issue? A github issues are a great way to keep track of tasks, enhancements, and bugs for your projects. Once you included everything you are going to click the drop down arrow on the green button and select "Create draft pull request" When you create a Draft Pull Request, it cannot be merged until it is marked as ready for review. |
There was a problem hiding this comment.
This is too complicated you need to format this better so its easier to read.
Editing Line 11
Editing Line 43
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.
Regarding issues to help new students to contribute to Open Source. This whole Pull Request is going to be based on documentation that will show students from start to finish how to properly contribute to open source.
Fixes #65