-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
adding in documentation on how to contribute to the project via GitHu…
…b's web interface
- Loading branch information
1 parent
72a5c42
commit 10b1e1f
Showing
12 changed files
with
67 additions
and
1 deletion.
There are no files selected for viewing
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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,3 +1,69 @@ | ||
## Ethics Structures | ||
|
||
### How to contribute: | ||
### How to contribute via the web interface: | ||
|
||
Taken from this [wiki](https://github.com/WGBH/pbucore/wiki/Contributing-to-the-project-through-Github-web-interface) | ||
|
||
If you are comfortable using git from the command line of your computer, please do that. If not, then follow this guide to contribute to the project through Github's web interface. | ||
|
||
|
||
### Create a branch | ||
|
||
![](img/create-branch.png?raw=true) | ||
|
||
From project home page, locate the drop down that lists the branches, and make sure you are on the master branch. | ||
|
||
Click the box, and type in a meaningful name for your new branch. Then click "Create branch". Please do make sure you are creating your branch from 'master'. | ||
|
||
![](img/create-branch-2.png?raw=true) | ||
|
||
### Copy the file to your computer for editing | ||
|
||
Awesome! You have a branch. Now you can copy the file from Github to your computer, and make some changes. Navigate to a file you want to change, e.g. README.md | ||
|
||
![](img/copy-file.png?raw=true) | ||
|
||
Click the file to view it. Notice that you are still on the branch you created in Create a branch. Here you can copy and paste the file to your computer, and make edits. | ||
|
||
HINT: The Raw button which is located to the left of the screen, will display a view of the file that may be easier to copy. | ||
![](img/raw-screen.png?raw=true) | ||
|
||
### Commit your changed file to your branch on Github | ||
|
||
After you are satisfied with the changes you made to your file on your computer, you are ready to commit it to your branch in the Github repository. From the screen in Copy the file to your computer for editing, click on the "Edit" icon (with the pencil, toward the left of the screen). | ||
|
||
![](img/edit-button.png?raw=true) | ||
|
||
Here you are presented with the Github editor. Copy and paste the file from your computer into the editor. | ||
|
||
![](img/edit-screen.png?raw=true) | ||
|
||
When you are ready to commit your change, scroll to the bottom of the editor. Enter a meaningful commit message. Make sure the Commit directly to [your branch] option is selected. Click "Commit changes". | ||
|
||
![](img/commit-changes.png?raw=true) | ||
|
||
### Add new files to your branch on Github. | ||
|
||
If you need to add new files, go back to the project home page. Make sure you are on your branch, then click the + button after pbucore / . | ||
|
||
![](img/add-new-files-1.png?raw=true) | ||
|
||
Give your file an appropriate name, use the editor to write (or paste) your file. | ||
|
||
![](img/add-new-files.png?raw=true) | ||
|
||
At the bottom of the screen, commit your file in the same way as you did in 'Commit your changed file to your branch on Github' | ||
|
||
### Create a pull request (PR) for your branch. | ||
|
||
After adding/editing all the files you need to, go back to the project home page. You may see a bar labeled "Your recently pushed branches" that contains your branch name. If you are ready to merge your branch into the master branch, click the "Compare & pull request" button. | ||
|
||
![](img/open-pr.png?raw=true) | ||
|
||
Enter a meaningful message that briefly describes your branch as a whole. Then click "Create pull request". | ||
|
||
![](img/pr-message.png?raw=true) | ||
|
||
### Wait for merge, or you may receive a request from the repo maintainer(s) for changes to your pr. | ||
|
||
Congrats! We now have a PR for your branch that can be reviewed by others, and hopefully merged into the master branch. |
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.